Contents

updateMail

An intent schema that makes updates to one or more existing email messages by modifying the status, flags, and location.

Declaration

var updateMail: some AppSchemaIntent { get }

Discussion

To make your app’s actions available to Apple Intelligence, conform your AppIntent to a schema that describes your action to the system. If your app’s functionality aligns with the mail domain and one of your app’s actions matches the updateMail schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .mail.updateMail) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an intent that conforms to the updateMail schema:

@AppIntent(schema: .mail.updateMail)
struct UpdateMailIntent {
    var target: [<#MailMessageEntity#>]
    var isRead: Bool?
    var isFlagged: Bool?
    var isJunk: Bool?
    var mailbox: <#MailboxEntity#>?

    func perform() async throws -> some IntentResult {
        <#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.

See Also

Actions