Resource
inbox_folder
A mailbox intake configuration. Runtime activation is separate from editing.
Configuration
nameString!RequiredUnique mailbox name within the tenant.
descriptionStringOptionalOptional description; null clears on replacement.
storageFolderIdFolderID!RequiredFolder for accepted content.
References folder
retrievalMailboxRetrievalConfiguration!RequiredIMAP or POP3 endpoint without credentials.
submissionMailboxSubmissionConfigurationOptionalOptional SMTP endpoint; null removes on replacement.
policiesInboxPolicies!RequiredComplete intake policy configuration.
Input types
Fields for the structured values used in this resource’s configuration.
MailboxRetrievalConfigurationInput
Mailbox configuration; contains no credentials.
kindMailboxProtocol!Requiredkind configuration.
Allowed values
IMAP — imap
POP3 — pop3
endpointMailboxEndpointInput!Requiredendpoint configuration.
accountIdentityString!RequiredaccountIdentity configuration.
folderStringOptionalfolder configuration.
pollIntervalSecondsInt!RequiredpollIntervalSeconds configuration.
trustedReceiverHeadersMailboxTrustedReceiverHeadersInputOptionalProtected MTA envelope headers. Nil leaves sender/recipient evidence untrusted.
MailboxSubmissionConfigurationInput
Mailbox configuration; contains no credentials.
endpointMailboxEndpointInput!Requiredendpoint configuration.
fromAddressString!RequiredfromAddress configuration.
displayNameStringOptionaldisplayName configuration.
InboxPoliciesInput
Mailbox configuration; contains no credentials.
acceptedRecipients[String!]!RequiredacceptedRecipients configuration.
allowedSenders[String!]!RequiredallowedSenders configuration.
allowedSenderDomains[String!]!RequiredallowedSenderDomains configuration.
unknownSenderInboxUnknownSenderPolicy!RequiredunknownSender configuration.
Allowed values
ACCEPT — accept
REVIEW — review
IGNORE — ignore
allowedOutboundRecipients[String!]!RequiredallowedOutboundRecipients configuration.
allowedOutboundDomains[String!]!RequiredallowedOutboundDomains configuration.
allowedMediaTypes[String!]!RequiredallowedMediaTypes configuration.
maxMessageBytesInt!RequiredmaxMessageBytes configuration.
maxAttachmentsInt!RequiredmaxAttachments configuration.
maxCapturesPerHourIntOptionalMaximum successfully staged messages in any UTC-hour bucket; omitted uses the legacy-safe default.
maxStorageMiBIntOptionalMaximum mebibytes reserved or retained for inbox-owned message content; omitted uses the legacy-safe default.
maxConcurrentCapturesIntOptionalMaximum concurrent remote message fetches; omitted uses the legacy-safe default.
retentionDaysInt!RequiredretentionDays configuration.
quarantineRetentionDaysInt!RequiredquarantineRetentionDays configuration.
auditRetentionDaysInt!RequiredauditRetentionDays configuration.
acknowledgementTemplateStringOptionalacknowledgementTemplate configuration.
acknowledgeRepliesBoolean!RequiredacknowledgeReplies configuration.
maxAcknowledgementsPerSenderPerHourInt!RequiredmaxAcknowledgementsPerSenderPerHour configuration.
maxAcknowledgementsPerInboxPerHourIntOptionalMaximum acknowledgements per inbox in any rolling hour; omitted uses the legacy-safe default.
MailboxEndpointInput
Mailbox configuration; contains no credentials.
hostString!Requiredhost configuration.
portInt!Requiredport configuration.
tlsMailboxTLSMode!Requiredtls configuration.
Allowed values
IMPLICIT — implicit
START_TLS — startTLS
usernameString!Requiredusername configuration.
MailboxTrustedReceiverHeadersInput
Use only header names guaranteed to be replaced or stripped by the configured MTA.
envelopeSenderString!RequiredProtected MTA header name.
deliveredRecipientString!RequiredProtected MTA header name.
authenticatedSenderStringOptionalOptional protected MTA header name.
automatedStringOptionalOptional protected MTA header name.
Read-only values
Show values
idInboxFolderID!Read onlyid of the mailbox configuration.
computed by the platform
tenantIdTenantID!Read onlytenantId of the mailbox configuration.
computed by the platform
configurationRevisionInt!Read onlyconfigurationRevision of the mailbox configuration.
computed by the platform
isEnabledBoolean!Read onlyisEnabled of the mailbox configuration; activation uses the separate lifecycle API.
computed by the platform
archivedAtStringRead onlyTerminal archive timestamp; archived configurations cannot be resumed.
computed by the platform
createdAtString!Read onlycreatedAt of the mailbox configuration.
computed by the platform
updatedAtString!Read onlyupdatedAt of the mailbox configuration.
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.