mailbox

Declaration

var mailbox: some AssistantSchemas.Entity { get }

Overview

Use Swift macros that generate additional properties and add protocol conformance for your app entity implementation. The following example shows an app entity that conforms to the .mail.mailbox schema:

@AppEntity(schema: .mail.mailbox)
struct MailboxEntity: AppEntity {
    struct Query: EntityStringQuery {
        func entities(for identifiers: [MailboxEntity.ID]) async throws -> [MailboxEntity] { [] }
        func entities(matching string: String) async throws -> [MailboxEntity] { [] }
    }

    static var defaultQuery = Query()
    var displayRepresentation: DisplayRepresentation { "Mailbox" }

    let id = UUID()

    @Property
    var name: String

    @Property
    var account: MailAccountEntity
}

For more information about the .mail app intent domain, see doc:Making-email-actions-available-to-siri-and-apple-intelligence. For general information about app intent domains, see doc:Integrating-actions-with-siri-and-apple-intelligence.