--- description: Capacitor plugin to open the native email composer prefilled with recipients, subject, body, and attachments. Supports Android, iOS, and the web (via mailto:). title: Capacitor Mail Composer Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/mail-composer.png --- [Skip to content ](#capacitor-mail-composer-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * Mail Composer [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Web ](#web) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Platform Support ](#platform-support) * [ Changelog ](#changelog) * [ License ](#license) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Web ](#web) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Platform Support ](#platform-support) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Mail Composer Plugin[ΒΆ](#capacitor-mail-composer-plugin "Permanent link") Capacitor plugin to open the native email composer. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") * βœ‰οΈ **Compose**: Open the native email composer prefilled with recipients, subject and body. * πŸ“Ž **Attachments**: Attach one or more files to the email. * βœ… **Availability**: Check whether the device is able to compose and send emails. * 🌐 **Cross-platform**: Supports Android, iOS and the web (via `mailto:`). * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-mail-composer` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-mail-composer [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") #### Attachments[ΒΆ](#attachments "Permanent link") To attach files, the plugin uses the [FileProvider](https://developer.android.com/reference/androidx/core/content/FileProvider) that Capacitor already registers for your app (authority `${applicationId}.fileprovider`). Make sure that the directories your attachments are stored in are covered by the `res/xml/file_paths.xml` resource of your app. Otherwise, the `composeMail(...)` method will reject with an error. ### Web[ΒΆ](#web "Permanent link") On the web, the plugin builds a `mailto:` URL and opens it. This has the following limitations: * Attachments are **not** supported and cause the `composeMail(...)` method to reject. * HTML bodies are **not** supported. The body is always sent as plain text. * The overall URL length is limited, so long bodies may be truncated. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { MailComposer } from '@capawesome/capacitor-mail-composer'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const canComposeMail = async () => { [](#%5F%5Fcodelineno-3-4) const { canCompose } = await MailComposer.canComposeMail(); [](#%5F%5Fcodelineno-3-5) return canCompose; [](#%5F%5Fcodelineno-3-6)}; [](#%5F%5Fcodelineno-3-7) [](#%5F%5Fcodelineno-3-8)const composeMail = async () => { [](#%5F%5Fcodelineno-3-9) const { status } = await MailComposer.composeMail({ [](#%5F%5Fcodelineno-3-10) to: ['jane@example.com'], [](#%5F%5Fcodelineno-3-11) cc: ['john@example.com'], [](#%5F%5Fcodelineno-3-12) subject: 'Hello World', [](#%5F%5Fcodelineno-3-13) body: 'This is the body of the email.', [](#%5F%5Fcodelineno-3-14) }); [](#%5F%5Fcodelineno-3-15) return status; [](#%5F%5Fcodelineno-3-16)}; ` ## API[ΒΆ](#api "Permanent link") * [canComposeMail()](#cancomposemail) * [composeMail(...)](#composemail) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### canComposeMail()[ΒΆ](#cancomposemail "Permanent link") `[](#%5F%5Fcodelineno-4-1)canComposeMail() => Promise ` Check whether the device is able to compose and send emails. On iOS, this returns `true` only if a mail account is configured. On Android, this returns `true` if a mail app is installed. On the web, this always returns `true` (best effort, not verifiable). **Returns:** `Promise<[CanComposeMailResult](#cancomposemailresult)>` **Since:** 0.1.0 --- ### composeMail(...)[ΒΆ](#composemail "Permanent link") `[](#%5F%5Fcodelineno-5-1)composeMail(options: ComposeMailOptions) => Promise ` Open the native email composer prefilled with the provided data. The user reviews the email and decides whether to send it. The plugin never sends the email itself. | Param | Type | | ----------- | ----------------------------------------- | | **options** | [ComposeMailOptions](#composemailoptions) | **Returns:** `Promise<[ComposeMailResult](#composemailresult)>` **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### CanComposeMailResult[ΒΆ](#cancomposemailresult "Permanent link") | Prop | Type | Description | Since | | -------------- | ------- | ------------------------------------------------------ | ----- | | **canCompose** | boolean | Whether the device is able to compose and send emails. | 0.1.0 | #### ComposeMailResult[ΒΆ](#composemailresult "Permanent link") | Prop | Type | Description | Since | | ---------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **status** | [MailComposeStatus](#mailcomposestatus) | The status of the email compose operation. **Note**: On Android, the status is always unknown because the mail intent does not return a reliable result. | 0.1.0 | #### ComposeMailOptions[ΒΆ](#composemailoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----- | | **attachments** | string\[\] | The absolute file paths or file:// URIs of the files to attach. Attachments are not supported on the web. | | 0.1.0 | | **bcc** | string\[\] | The email addresses of the blind carbon copy (BCC) recipients. | | 0.1.0 | | **body** | string | The body of the email. | | 0.1.0 | | **cc** | string\[\] | The email addresses of the carbon copy (CC) recipients. | | 0.1.0 | | **isHtml** | boolean | Whether the body should be interpreted as HTML. **Note**: On Android, HTML is best-effort as many mail apps ignore it. On the web, HTML is not supported and the body is always sent as plain text. | false | 0.1.0 | | **subject** | string | The subject of the email. | | 0.1.0 | | **to** | string\[\] | The email addresses of the primary recipients. | | 0.1.0 | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### MailComposeStatus[ΒΆ](#mailcomposestatus "Permanent link") The status of an email compose operation. * `sent`: The email was sent. * `saved`: The email was saved as a draft. * `canceled`: The user canceled the operation. * `unknown`: The status is unknown. `'sent' | 'saved' | 'canceled' | 'unknown'` ## Platform Support[ΒΆ](#platform-support "Permanent link") Keep the following platform-specific behavior in mind: * **Status**: On Android, the `status` returned by `composeMail(...)` is always `unknown` because the mail intent does not return a reliable result. On iOS, the real status is returned via the delegate. On the web, the status is always `unknown`. * **HTML body**: On Android, the `isHtml` option is best-effort because many mail apps ignore HTML content. On the web, HTML is not supported at all. * **No mail account**: On iOS, `composeMail(...)` rejects as unavailable if no mail account is configured. Use `canComposeMail(...)` to check upfront. ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/mail-composer/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/mail-composer/LICENSE). July 7, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/mail-composer/#article", "headline": "Capacitor Mail Composer Plugin", "name": "Capacitor Mail Composer Plugin", "description": "Capacitor plugin to open the native email composer prefilled with recipients, subject, body, and attachments. Supports Android, iOS, and the web (via mailto:).", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/mail-composer/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/mail-composer/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/mail-composer/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/mail-composer/#software", "name": "Capacitor Mail Composer Plugin", "description": "Capacitor plugin to open the native email composer prefilled with recipients, subject, body, and attachments. Supports Android, iOS, and the web (via mailto:).", "url": "https://capawesome.io/docs/sdks/capacitor/mail-composer/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} ```