message
An entity schema for a message.
Declaration
var message: 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 message schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .mail.message) 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 message schema:
@AppEntity(schema: .mail.message)
struct MailMessageEntity {
// MARK: Static
static let defaultQuery = MailMessageEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var to: [IntentPerson]
var cc: [IntentPerson]
var bcc: [IntentPerson]
var subject: String?
var body: AttributedString?
var attachments: [IntentFile]
var sender: IntentPerson
var dateSent: Date
var dateReceived: Date
var isRead: Bool
var isJunk: Bool
var isFlagged: Bool
var category: <#MailCategory#>?
var account: <#MailAccountEntity#>
var mailbox: <#MailboxEntity#>
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct MailMessageEntityQuery: EntityQuery {
func entities(for identifiers: [MailMessageEntity.ID]) async throws -> [MailMessageEntity] {
<#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.