mailbox

An entity schema for a mailbox.

Declaration

var mailbox: some AppSchemaEntity { get }

Discussion

To make your app’s content available to Apple Intelligence, conform your AppEntity to a schema that describes your content to the system. If your app’s functionality aligns with the mail domain and its content matches the mailbox schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .mail.mailbox) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an app entity that conforms to the mailbox schema:

@AppEntity(schema: .mail.mailbox)
struct MailboxEntity {
    // MARK: Static

    static let defaultQuery = MailboxEntityQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var name: String
    var account: <#MailAccountEntity#>

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

    struct MailboxEntityQuery: EntityQuery {
        func entities(for identifiers: [MailboxEntity.ID]) async throws -> [MailboxEntity] {
            <#code#>
        }
    }
}

The schema supports the following system experiences:

Siri
Shortcuts

For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.

mailbox

Declaration

Discussion

See Also

Content and parameter types