← All resources

Resource

inbox_folder

A mailbox intake configuration. Runtime activation is separate from editing.

GraphQL reference →

Configuration

nameString!Required

Unique mailbox name within the tenant.

descriptionStringOptional

Optional description; null clears on replacement.

storageFolderIdFolderID!Required

Folder for accepted content.

References folder

retrievalMailboxRetrievalConfiguration!Required

IMAP or POP3 endpoint without credentials.

View MailboxRetrievalConfigurationInput fields →

submissionMailboxSubmissionConfigurationOptional

Optional SMTP endpoint; null removes on replacement.

View MailboxSubmissionConfigurationInput fields →

policiesInboxPolicies!Required

Complete intake policy configuration.

View InboxPoliciesInput fields →

Input types

Fields for the structured values used in this resource’s configuration.

MailboxRetrievalConfigurationInput

Mailbox configuration; contains no credentials.

kindMailboxProtocol!Required

kind configuration.

Allowed values

IMAP — imap

POP3 — pop3

endpointMailboxEndpointInput!Required

endpoint configuration.

View MailboxEndpointInput fields →

accountIdentityString!Required

accountIdentity configuration.

folderStringOptional

folder configuration.

pollIntervalSecondsInt!Required

pollIntervalSeconds configuration.

trustedReceiverHeadersMailboxTrustedReceiverHeadersInputOptional

Protected MTA envelope headers. Nil leaves sender/recipient evidence untrusted.

View MailboxTrustedReceiverHeadersInput fields →

MailboxSubmissionConfigurationInput

Mailbox configuration; contains no credentials.

endpointMailboxEndpointInput!Required

endpoint configuration.

View MailboxEndpointInput fields →

fromAddressString!Required

fromAddress configuration.

displayNameStringOptional

displayName configuration.

InboxPoliciesInput

Mailbox configuration; contains no credentials.

acceptedRecipients[String!]!Required

acceptedRecipients configuration.

allowedSenders[String!]!Required

allowedSenders configuration.

allowedSenderDomains[String!]!Required

allowedSenderDomains configuration.

unknownSenderInboxUnknownSenderPolicy!Required

unknownSender configuration.

Allowed values

ACCEPT — accept

REVIEW — review

IGNORE — ignore

allowedOutboundRecipients[String!]!Required

allowedOutboundRecipients configuration.

allowedOutboundDomains[String!]!Required

allowedOutboundDomains configuration.

allowedMediaTypes[String!]!Required

allowedMediaTypes configuration.

maxMessageBytesInt!Required

maxMessageBytes configuration.

maxAttachmentsInt!Required

maxAttachments configuration.

maxCapturesPerHourIntOptional

Maximum successfully staged messages in any UTC-hour bucket; omitted uses the legacy-safe default.

maxStorageMiBIntOptional

Maximum mebibytes reserved or retained for inbox-owned message content; omitted uses the legacy-safe default.

maxConcurrentCapturesIntOptional

Maximum concurrent remote message fetches; omitted uses the legacy-safe default.

retentionDaysInt!Required

retentionDays configuration.

quarantineRetentionDaysInt!Required

quarantineRetentionDays configuration.

auditRetentionDaysInt!Required

auditRetentionDays configuration.

acknowledgementTemplateStringOptional

acknowledgementTemplate configuration.

acknowledgeRepliesBoolean!Required

acknowledgeReplies configuration.

maxAcknowledgementsPerSenderPerHourInt!Required

maxAcknowledgementsPerSenderPerHour configuration.

maxAcknowledgementsPerInboxPerHourIntOptional

Maximum acknowledgements per inbox in any rolling hour; omitted uses the legacy-safe default.

MailboxEndpointInput

Mailbox configuration; contains no credentials.

hostString!Required

host configuration.

portInt!Required

port configuration.

tlsMailboxTLSMode!Required

tls configuration.

Allowed values

IMPLICIT — implicit

START_TLS — startTLS

usernameString!Required

username configuration.

MailboxTrustedReceiverHeadersInput

Use only header names guaranteed to be replaced or stripped by the configured MTA.

envelopeSenderString!Required

Protected MTA header name.

deliveredRecipientString!Required

Protected MTA header name.

authenticatedSenderStringOptional

Optional protected MTA header name.

automatedStringOptional

Optional protected MTA header name.

Read-only values

Show values
idInboxFolderID!Read only

id of the mailbox configuration.

computed by the platform

tenantIdTenantID!Read only

tenantId of the mailbox configuration.

computed by the platform

configurationRevisionInt!Read only

configurationRevision of the mailbox configuration.

computed by the platform

isEnabledBoolean!Read only

isEnabled of the mailbox configuration; activation uses the separate lifecycle API.

computed by the platform

archivedAtStringRead only

Terminal archive timestamp; archived configurations cannot be resumed.

computed by the platform

createdAtString!Read only

createdAt of the mailbox configuration.

computed by the platform

updatedAtString!Read only

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