@capawesome/capacitor-mail-composer 0.0.1

package/dist/plugin.js

@@ -0,0 +1,71 @@
+var capacitorMailComposer = (function (exports, core) {
+    'use strict';
+
+    /**
+     * @since 0.1.0
+     */
+    exports.ErrorCode = void 0;
+    (function (ErrorCode) {
+        /**
+         * An attachment could not be found at the provided path.
+         *
+         * @since 0.1.0
+         */
+        ErrorCode["AttachmentNotFound"] = "ATTACHMENT_NOT_FOUND";
+        /**
+         * The email could not be composed.
+         *
+         * @since 0.1.0
+         */
+        ErrorCode["ComposeFailed"] = "COMPOSE_FAILED";
+    })(exports.ErrorCode || (exports.ErrorCode = {}));
+
+    const MailComposer = core.registerPlugin('MailComposer', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.MailComposerWeb()),
+    });
+
+    class MailComposerWeb extends core.WebPlugin {
+        async canComposeMail() {
+            return { canCompose: true };
+        }
+        async composeMail(options) {
+            if (options.attachments && options.attachments.length > 0) {
+                throw new Error(MailComposerWeb.errorAttachmentsNotSupported);
+            }
+            const url = this.createMailtoUrl(options);
+            window.open(url, '_self');
+            return { status: 'unknown' };
+        }
+        createMailtoUrl(options) {
+            var _a;
+            const to = ((_a = options.to) !== null && _a !== void 0 ? _a : []).join(',');
+            const params = new URLSearchParams();
+            if (options.cc && options.cc.length > 0) {
+                params.set('cc', options.cc.join(','));
+            }
+            if (options.bcc && options.bcc.length > 0) {
+                params.set('bcc', options.bcc.join(','));
+            }
+            if (options.subject) {
+                params.set('subject', options.subject);
+            }
+            if (options.body) {
+                params.set('body', options.body);
+            }
+            const query = params.toString();
+            return `mailto:${encodeURIComponent(to)}${query ? `?${query}` : ''}`;
+        }
+    }
+    MailComposerWeb.errorAttachmentsNotSupported = 'Attachments are not supported on the web.';
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        MailComposerWeb: MailComposerWeb
+    });
+
+    exports.MailComposer = MailComposer;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/definitions.js","esm/index.js","esm/web.js"],"sourcesContent":["/**\n * @since 0.1.0\n */\nexport var ErrorCode;\n(function (ErrorCode) {\n    /**\n     * An attachment could not be found at the provided path.\n     *\n     * @since 0.1.0\n     */\n    ErrorCode[\"AttachmentNotFound\"] = \"ATTACHMENT_NOT_FOUND\";\n    /**\n     * The email could not be composed.\n     *\n     * @since 0.1.0\n     */\n    ErrorCode[\"ComposeFailed\"] = \"COMPOSE_FAILED\";\n})(ErrorCode || (ErrorCode = {}));\n//# sourceMappingURL=definitions.js.map","import { registerPlugin } from '@capacitor/core';\nconst MailComposer = registerPlugin('MailComposer', {\n    web: () => import('./web').then(m => new m.MailComposerWeb()),\n});\nexport * from './definitions';\nexport { MailComposer };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class MailComposerWeb extends WebPlugin {\n    async canComposeMail() {\n        return { canCompose: true };\n    }\n    async composeMail(options) {\n        if (options.attachments && options.attachments.length > 0) {\n            throw new Error(MailComposerWeb.errorAttachmentsNotSupported);\n        }\n        const url = this.createMailtoUrl(options);\n        window.open(url, '_self');\n        return { status: 'unknown' };\n    }\n    createMailtoUrl(options) {\n        var _a;\n        const to = ((_a = options.to) !== null && _a !== void 0 ? _a : []).join(',');\n        const params = new URLSearchParams();\n        if (options.cc && options.cc.length > 0) {\n            params.set('cc', options.cc.join(','));\n        }\n        if (options.bcc && options.bcc.length > 0) {\n            params.set('bcc', options.bcc.join(','));\n        }\n        if (options.subject) {\n            params.set('subject', options.subject);\n        }\n        if (options.body) {\n            params.set('body', options.body);\n        }\n        const query = params.toString();\n        return `mailto:${encodeURIComponent(to)}${query ? `?${query}` : ''}`;\n    }\n}\nMailComposerWeb.errorAttachmentsNotSupported = 'Attachments are not supported on the web.';\n//# sourceMappingURL=web.js.map"],"names":["ErrorCode","registerPlugin","WebPlugin"],"mappings":";;;IAAA;IACA;IACA;AACWA;IACX,CAAC,UAAU,SAAS,EAAE;IACtB;IACA;IACA;IACA;IACA;IACA,IAAI,SAAS,CAAC,oBAAoB,CAAC,GAAG,sBAAsB;IAC5D;IACA;IACA;IACA;IACA;IACA,IAAI,SAAS,CAAC,eAAe,CAAC,GAAG,gBAAgB;IACjD,CAAC,EAAEA,iBAAS,KAAKA,iBAAS,GAAG,EAAE,CAAC,CAAC;;AChB5B,UAAC,YAAY,GAAGC,mBAAc,CAAC,cAAc,EAAE;IACpD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;IACjE,CAAC;;ICFM,MAAM,eAAe,SAASC,cAAS,CAAC;IAC/C,IAAI,MAAM,cAAc,GAAG;IAC3B,QAAQ,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;IACnC,IAAI;IACJ,IAAI,MAAM,WAAW,CAAC,OAAO,EAAE;IAC/B,QAAQ,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;IACnE,YAAY,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,4BAA4B,CAAC;IACzE,QAAQ;IACR,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;IACjD,QAAQ,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;IACjC,QAAQ,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE;IACpC,IAAI;IACJ,IAAI,eAAe,CAAC,OAAO,EAAE;IAC7B,QAAQ,IAAI,EAAE;IACd,QAAQ,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC;IACpF,QAAQ,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE;IAC5C,QAAQ,IAAI,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;IACjD,YAAY,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,QAAQ;IACR,QAAQ,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;IACnD,YAAY,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,QAAQ;IACR,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE;IAC7B,YAAY,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC;IAClD,QAAQ;IACR,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE;IAC1B,YAAY,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC;IAC5C,QAAQ;IACR,QAAQ,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE;IACvC,QAAQ,OAAO,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5E,IAAI;IACJ;IACA,eAAe,CAAC,4BAA4B,GAAG,2CAA2C;;;;;;;;;;;;;;;"}

package/ios/Plugin/Classes/Options/ComposeMailOptions.swift

@@ -0,0 +1,22 @@
+import Foundation
+import Capacitor
+
+@objc public class ComposeMailOptions: NSObject {
+    let attachments: [String]
+    let bccRecipients: [String]
+    let body: String?
+    let ccRecipients: [String]
+    let isHtml: Bool
+    let subject: String?
+    let toRecipients: [String]
+
+    init(_ call: CAPPluginCall) {
+        self.toRecipients = call.getArray("to", String.self) ?? []
+        self.ccRecipients = call.getArray("cc", String.self) ?? []
+        self.bccRecipients = call.getArray("bcc", String.self) ?? []
+        self.subject = call.getString("subject")
+        self.body = call.getString("body")
+        self.isHtml = call.getBool("isHtml", false)
+        self.attachments = call.getArray("attachments", String.self) ?? []
+    }
+}

package/ios/Plugin/Classes/Results/CanComposeMailResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class CanComposeMailResult: NSObject, Result {
+    let canCompose: Bool
+
+    init(canCompose: Bool) {
+        self.canCompose = canCompose
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["canCompose"] = canCompose
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Results/ComposeMailResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class ComposeMailResult: NSObject, Result {
+    let status: String
+
+    init(status: String) {
+        self.status = status
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["status"] = status
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Enums/CustomError.swift

@@ -0,0 +1,31 @@
+import Foundation
+
+enum CustomError: Error {
+    case attachmentNotFound
+    case composeFailed
+    case mailServicesUnavailable
+
+    var code: String? {
+        switch self {
+        case .attachmentNotFound:
+            return "ATTACHMENT_NOT_FOUND"
+        case .composeFailed:
+            return "COMPOSE_FAILED"
+        case .mailServicesUnavailable:
+            return nil
+        }
+    }
+}
+
+extension CustomError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .attachmentNotFound:
+            return NSLocalizedString("An attachment could not be found at the provided path.", comment: "attachmentNotFound")
+        case .composeFailed:
+            return NSLocalizedString("The email could not be composed.", comment: "composeFailed")
+        case .mailServicesUnavailable:
+            return NSLocalizedString("No mail account is configured on this device.", comment: "mailServicesUnavailable")
+        }
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>

package/ios/Plugin/MailComposer.swift

@@ -0,0 +1,88 @@
+import Foundation
+import Capacitor
+import MessageUI
+import UniformTypeIdentifiers
+
+@objc public class MailComposer: NSObject {
+    private let plugin: MailComposerPlugin
+    private var composeCompletion: ((ComposeMailResult?, Error?) -> Void)?
+
+    init(plugin: MailComposerPlugin) {
+        self.plugin = plugin
+    }
+
+    @objc public func canComposeMail(completion: @escaping (CanComposeMailResult?, Error?) -> Void) {
+        let result = CanComposeMailResult(canCompose: MFMailComposeViewController.canSendMail())
+        completion(result, nil)
+    }
+
+    @objc public func composeMail(_ options: ComposeMailOptions, completion: @escaping (ComposeMailResult?, Error?) -> Void) {
+        DispatchQueue.main.async {
+            guard MFMailComposeViewController.canSendMail() else {
+                completion(nil, CustomError.mailServicesUnavailable)
+                return
+            }
+            let controller = MFMailComposeViewController()
+            controller.mailComposeDelegate = self
+            controller.setToRecipients(options.toRecipients)
+            controller.setCcRecipients(options.ccRecipients)
+            controller.setBccRecipients(options.bccRecipients)
+            if let subject = options.subject {
+                controller.setSubject(subject)
+            }
+            if let body = options.body {
+                controller.setMessageBody(body, isHTML: options.isHtml)
+            }
+            for attachment in options.attachments {
+                let url = Self.createFileUrl(from: attachment)
+                guard let data = try? Data(contentsOf: url) else {
+                    completion(nil, CustomError.attachmentNotFound)
+                    return
+                }
+                controller.addAttachmentData(data, mimeType: Self.mimeType(for: url), fileName: url.lastPathComponent)
+            }
+            self.composeCompletion = completion
+            self.plugin.bridge?.viewController?.present(controller, animated: true)
+        }
+    }
+
+    private static func createFileUrl(from path: String) -> URL {
+        if path.hasPrefix("file://") {
+            return URL(string: path) ?? URL(fileURLWithPath: path)
+        }
+        return URL(fileURLWithPath: path)
+    }
+
+    private static func mapResult(_ result: MFMailComposeResult) -> String {
+        switch result {
+        case .sent:
+            return "sent"
+        case .saved:
+            return "saved"
+        case .cancelled:
+            return "canceled"
+        default:
+            return "unknown"
+        }
+    }
+
+    private static func mimeType(for url: URL) -> String {
+        if let type = UTType(filenameExtension: url.pathExtension), let mimeType = type.preferredMIMEType {
+            return mimeType
+        }
+        return "application/octet-stream"
+    }
+}
+
+extension MailComposer: MFMailComposeViewControllerDelegate {
+    public func mailComposeController(_ controller: MFMailComposeViewController, didFinishWith result: MFMailComposeResult, error: Error?) {
+        controller.dismiss(animated: true)
+        let completion = composeCompletion
+        composeCompletion = nil
+        if result == .failed {
+            completion?(nil, CustomError.composeFailed)
+            return
+        }
+        completion?(ComposeMailResult(status: Self.mapResult(result)), nil)
+    }
+}

package/ios/Plugin/MailComposerPlugin.swift

@@ -0,0 +1,62 @@
+import Foundation
+import Capacitor
+
+@objc(MailComposerPlugin)
+public class MailComposerPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "MailComposerPlugin"
+    public let jsName = "MailComposer"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "canComposeMail", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "composeMail", returnType: CAPPluginReturnPromise)
+    ]
+    public static let tag = "MailComposerPlugin"
+
+    private var implementation: MailComposer?
+
+    override public func load() {
+        self.implementation = MailComposer(plugin: self)
+    }
+
+    @objc func canComposeMail(_ call: CAPPluginCall) {
+        implementation?.canComposeMail { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    @objc func composeMail(_ call: CAPPluginCall) {
+        let options = ComposeMailOptions(call)
+        implementation?.composeMail(options) { result, error in
+            if let error = error {
+                if case CustomError.mailServicesUnavailable = error {
+                    self.rejectCallAsUnavailable(call)
+                } else {
+                    self.rejectCall(call, error)
+                }
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    private func rejectCall(_ call: CAPPluginCall, _ error: Error) {
+        CAPLog.print("[", MailComposerPlugin.tag, "] ", error)
+        let code = (error as? CustomError)?.code
+        call.reject(error.localizedDescription, code)
+    }
+
+    private func rejectCallAsUnavailable(_ call: CAPPluginCall) {
+        call.unavailable("This method is not available on this platform.")
+    }
+
+    private func resolveCall(_ call: CAPPluginCall, _ result: Result?) {
+        if let result = result?.toJSObject() as? JSObject {
+            call.resolve(result)
+        } else {
+            call.resolve()
+        }
+    }
+}

package/ios/Plugin/Protocols/Result.swift

@@ -0,0 +1,5 @@
+import Capacitor
+
+@objc public protocol Result {
+    @objc func toJSObject() -> AnyObject
+}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@capawesome/capacitor-mail-composer",
+  "version": "0.0.1",
+  "description": "Capacitor plugin to open the native email composer.",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Plugin/",
+    "CapawesomeCapacitorMailComposer.podspec",
+    "Package.swift"
+  ],
+  "author": "Robin Genz <mail@robingenz.dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/capawesome-team/capacitor-plugins.git"
+  },
+  "bugs": {
+    "url": "https://github.com/capawesome-team/capacitor-plugins/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/capawesome-team/"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/capawesome"
+    }
+  ],
+  "homepage": "https://capawesome.io/docs/plugins/mail-composer/",
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api MailComposerPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "ios:pod:install": "cd ios && pod install --repo-update && cd ..",
+    "ios:spm:install": "cd ios && swift package resolve && cd ..",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "8.0.0",
+    "@capacitor/cli": "8.0.0",
+    "@capacitor/core": "8.0.0",
+    "@capacitor/docgen": "0.3.1",
+    "@capacitor/ios": "8.0.0",
+    "@ionic/eslint-config": "0.4.0",
+    "eslint": "8.57.0",
+    "prettier-plugin-java": "2.6.7",
+    "rimraf": "6.1.2",
+    "rollup": "4.53.3",
+    "swiftlint": "2.0.0",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}