New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
capacitor-email-composer
Advanced tools
capacitor-email-composer - npm Package Compare versions
Comparing version 2.0.1 to 5.0.0
@@ -10,18 +10,15 @@ { | ||
| "name": "hasAccount", | ||
| "signature": "() => Promise<{ hasAccount: boolean; }>", | ||
| "signature": "() => Promise<HasAccountResult>", | ||
| "parameters": [], | ||
| "returns": "Promise<{ hasAccount: boolean; }>", | ||
| "returns": "Promise<HasAccountResult>", | ||
| "tags": [ | ||
| { | ||
| "name": "since", | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| "text": "1.0.0" | ||
| } | ||
| ], | ||
| "docs": "Checks if the User can send a Mail\niOS: Check if the current Device is configured to send mail\nAndroid: Currently does nothing", | ||
| "complexTypes": [], | ||
| "complexTypes": [ | ||
| "HasAccountResult" | ||
| ], | ||
| "slug": "hasaccount" | ||
@@ -31,3 +28,3 @@ }, | ||
| "name": "open", | ||
| "signature": "(options?: OpenOptions) => Promise<void>", | ||
| "signature": "(options?: OpenOptions | undefined) => Promise<void>", | ||
| "parameters": [ | ||
@@ -44,25 +41,7 @@ { | ||
| "name": "param", | ||
| "text": [ | ||
| { | ||
| "text": "options", | ||
| "kind": "parameterName" | ||
| }, | ||
| { | ||
| "text": " ", | ||
| "kind": "space" | ||
| }, | ||
| { | ||
| "text": "optional Options to prefill the E-Mail", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| "text": "options optional Options to prefill the E-Mail" | ||
| }, | ||
| { | ||
| "name": "since", | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| "text": "1.0.0" | ||
| } | ||
@@ -81,2 +60,23 @@ ], | ||
| { | ||
| "name": "HasAccountResult", | ||
| "slug": "hasaccountresult", | ||
| "docs": "", | ||
| "tags": [], | ||
| "methods": [], | ||
| "properties": [ | ||
| { | ||
| "name": "hasAccount", | ||
| "tags": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
| } | ||
| ], | ||
| "docs": "", | ||
| "complexTypes": [], | ||
| "type": "boolean" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "OpenOptions", | ||
@@ -92,8 +92,3 @@ "slug": "openoptions", | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
@@ -110,8 +105,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
@@ -128,8 +118,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
@@ -146,8 +131,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
@@ -164,8 +144,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.0", | ||
| "name": "since" | ||
@@ -182,8 +157,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.0.1", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.0.1", | ||
| "name": "since" | ||
@@ -200,8 +170,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.2.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.2.0", | ||
| "name": "since" | ||
@@ -229,8 +194,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.2.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.2.0", | ||
| "name": "since" | ||
@@ -247,8 +207,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.2.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.2.0", | ||
| "name": "since" | ||
@@ -265,8 +220,3 @@ } | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "1.2.0", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "text": "1.2.0", | ||
| "name": "since" | ||
@@ -273,0 +223,0 @@ } |
@@ -9,5 +9,3 @@ export interface EmailComposerPlugin { | ||
| */ | ||
| hasAccount(): Promise<{ | ||
| hasAccount: boolean; | ||
| }>; | ||
| hasAccount(): Promise<HasAccountResult>; | ||
| /** | ||
@@ -21,2 +19,8 @@ * Open the E-Mail Composer | ||
| } | ||
| export interface HasAccountResult { | ||
| /** | ||
| * @since 1.0.0 | ||
| */ | ||
| hasAccount: boolean; | ||
| } | ||
| export interface OpenOptions { | ||
@@ -23,0 +27,0 @@ /** |
| 'use strict'; | ||
| Object.defineProperty(exports, '__esModule', { value: true }); | ||
| var core = require('@capacitor/core'); | ||
@@ -6,0 +4,0 @@ |
@@ -8,4 +8,2 @@ var capacitorEmailComposer = (function (exports, core) { | ||
| Object.defineProperty(exports, '__esModule', { value: true }); | ||
| return exports; | ||
@@ -12,0 +10,0 @@ |
| { | ||
| "name": "capacitor-email-composer", | ||
| "version": "2.0.1", | ||
| "version": "5.0.0", | ||
| "description": "E-Mail Composer Plugin for Capacitor", | ||
@@ -40,33 +40,40 @@ "main": "dist/plugin.cjs.js", | ||
| "eslint": "eslint . --ext ts", | ||
| "prettier": "prettier \"**/*.{css,html,ts,js,java}\"", | ||
| "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --config .prettierrc.json", | ||
| "swiftlint": "node-swiftlint", | ||
| "swiftlint:fix": "node-swiftlint --fix --format", | ||
| "docgen": "docgen --api EmailComposerPlugin --output-readme README.md --output-json dist/docs.json && doctoc README.md --github --title '**Table of Content**' --maxlevel 3", | ||
| "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js", | ||
| "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs", | ||
| "clean": "rimraf ./dist", | ||
| "watch": "tsc --watch" | ||
| "watch": "tsc --watch", | ||
| "check:updates": "npm-check-updates" | ||
| }, | ||
| "devDependencies": { | ||
| "@capacitor/android": "5.0.3", | ||
| "@capacitor/cli": "5.0.3", | ||
| "@capacitor/core": "5.0.3", | ||
| "@capacitor/docgen": "0.0.16", | ||
| "@capacitor/ios": "5.0.3", | ||
| "@commitlint/config-conventional": "17.6.3", | ||
| "@capacitor/android": "5.7.0", | ||
| "@capacitor/cli": "5.7.0", | ||
| "@capacitor/core": "5.7.0", | ||
| "@capacitor/docgen": "0.2.2", | ||
| "@capacitor/ios": "5.7.0", | ||
| "@commitlint/config-conventional": "18.6.0", | ||
| "@ionic/eslint-config": "0.3.0", | ||
| "@ionic/prettier-config": "1.0.1", | ||
| "@ionic/prettier-config": "4.0.0", | ||
| "@ionic/swiftlint-config": "1.1.2", | ||
| "@saithodev/semantic-release-backmerge": "3.2.0", | ||
| "@saithodev/semantic-release-backmerge": "4.0.1", | ||
| "@semantic-release/changelog": "6.0.3", | ||
| "@semantic-release/exec": "6.0.3", | ||
| "@semantic-release/git": "10.0.1", | ||
| "@semantic-release/npm": "10.0.3", | ||
| "doctoc": "2.0.1", | ||
| "eslint": "7.32.0", | ||
| "prettier": "2.2.1", | ||
| "prettier-plugin-java": "1.0.2", | ||
| "rimraf": "3.0.2", | ||
| "rollup": "2.79.1", | ||
| "semantic-release": "21.0.2", | ||
| "@semantic-release/npm": "11.0.2", | ||
| "@typescript-eslint/eslint-plugin": "6.21.0", | ||
| "@typescript-eslint/parser": "6.21.0", | ||
| "doctoc": "2.2.1", | ||
| "eslint": "8.56.0", | ||
| "eslint-config-prettier": "9.1.0", | ||
| "eslint-plugin-prettier": "5.1.3", | ||
| "npm-check-updates": "16.14.14", | ||
| "prettier": "3.2.5", | ||
| "prettier-plugin-java": "2.5.0", | ||
| "rimraf": "5.0.5", | ||
| "rollup": "4.10.0", | ||
| "semantic-release": "23.0.2", | ||
| "swiftlint": "1.0.2", | ||
| "typescript": "4.9.5" | ||
| "typescript": "5.3.3" | ||
| }, | ||
@@ -73,0 +80,0 @@ "peerDependencies": { |
| # Capacitor E-Mail Composer | ||
|  | ||
|  | ||
| [](https://www.npmjs.com/package/capacitor-email-composer) | ||
@@ -8,10 +8,2 @@ | ||
| <!-- DONATE --> | ||
| [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=LMX5TSQVMNMU6&source=url) | ||
| This and other Open-Source Cordova/Capacitor Plugins are developed in my free time. | ||
| To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance. | ||
| Please consider donating if you're using this plugin in an app that makes you money, if you're being paid to make the app, if you're asking for new features or priority bug fixes. | ||
| <!-- END DONATE --> | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
@@ -32,2 +24,4 @@ <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| - [Changelog](#changelog) | ||
| - [Troubleshooting](#troubleshooting) | ||
| - [TransactionTooLargeException](#transactiontoolargeexception) | ||
@@ -53,3 +47,5 @@ <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
| ```ts | ||
| EmailComposerPlugin.open({ | ||
| import { EmailComposer } from 'capacitor-email-composer' | ||
| EmailComposer.open({ | ||
| attachments: [{ | ||
@@ -67,3 +63,5 @@ type: 'absolute', | ||
| ```ts | ||
| EmailComposerPlugin.open({ | ||
| import { EmailComposer } from 'capacitor-email-composer' | ||
| EmailComposer.open({ | ||
| attachments: [{ | ||
@@ -81,3 +79,5 @@ type: 'resource', | ||
| ```ts | ||
| EmailComposerPlugin.open({ | ||
| import { EmailComposer } from 'capacitor-email-composer' | ||
| EmailComposer.open({ | ||
| attachments: [{ | ||
@@ -95,3 +95,5 @@ type: 'asset', | ||
| ```ts | ||
| EmailComposerPlugin.open({ | ||
| import { EmailComposer } from 'capacitor-email-composer' | ||
| EmailComposer.open({ | ||
| attachments: [{ | ||
@@ -121,3 +123,3 @@ type: 'base64', | ||
| ```typescript | ||
| hasAccount() => Promise<{ hasAccount: boolean; }> | ||
| hasAccount() => Promise<HasAccountResult> | ||
| ``` | ||
@@ -129,4 +131,6 @@ | ||
| **Returns:** <code>Promise<{ hasAccount: boolean; }></code> | ||
| **Returns:** <code>Promise<<a href="#hasaccountresult">HasAccountResult</a>></code> | ||
| **Since:** 1.0.0 | ||
| -------------------- | ||
@@ -138,3 +142,3 @@ | ||
| ```typescript | ||
| open(options?: OpenOptions) => Promise<void> | ||
| open(options?: OpenOptions | undefined) => Promise<void> | ||
| ``` | ||
@@ -148,2 +152,4 @@ | ||
| **Since:** 1.0.0 | ||
| -------------------- | ||
@@ -155,13 +161,20 @@ | ||
| #### HasAccountResult | ||
| | Prop | Type | Since | | ||
| | ---------------- | -------------------- | ----- | | ||
| | **`hasAccount`** | <code>boolean</code> | 1.0.0 | | ||
| #### OpenOptions | ||
| | Prop | Type | Description | | ||
| | ----------------- | ------------------------- | ------------------------------------------------------------------------ | | ||
| | **`to`** | <code>string[]</code> | email addresses for TO field | | ||
| | **`cc`** | <code>string[]</code> | email addresses for CC field | | ||
| | **`bcc`** | <code>string[]</code> | email addresses for BCC field | | ||
| | **`subject`** | <code>string</code> | subject of the email | | ||
| | **`body`** | <code>string</code> | email body | | ||
| | **`isHtml`** | <code>boolean</code> | indicates if the body is HTML or plain text (primarily iOS) | | ||
| | **`attachments`** | <code>Attachment[]</code> | attachments that are added to the mail file paths or base64 data streams | | ||
| | Prop | Type | Description | Since | | ||
| | ----------------- | ------------------------- | ------------------------------------------------------------------------ | ----- | | ||
| | **`to`** | <code>string[]</code> | email addresses for TO field | 1.0.0 | | ||
| | **`cc`** | <code>string[]</code> | email addresses for CC field | 1.0.0 | | ||
| | **`bcc`** | <code>string[]</code> | email addresses for BCC field | 1.0.0 | | ||
| | **`subject`** | <code>string</code> | subject of the email | 1.0.0 | | ||
| | **`body`** | <code>string</code> | email body | 1.0.0 | | ||
| | **`isHtml`** | <code>boolean</code> | indicates if the body is HTML or plain text (primarily iOS) | 1.0.1 | | ||
| | **`attachments`** | <code>Attachment[]</code> | attachments that are added to the mail file paths or base64 data streams | 1.2.0 | | ||
@@ -171,7 +184,7 @@ | ||
| | Prop | Type | Description | | ||
| | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | ||
| | **`path`** | <code>string</code> | The path of the attachment. See the docs for explained informations. | | ||
| | **`type`** | <code>'absolute' \| 'resource' \| 'asset' \| 'base64'</code> | The type of the attachment. See the docs for explained informations. | | ||
| | **`name`** | <code>string</code> | The name of the attachment. See the docs for explained informations. Required for base64 attachements. | | ||
| | Prop | Type | Description | Since | | ||
| | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ----- | | ||
| | **`path`** | <code>string</code> | The path of the attachment. See the docs for explained informations. | 1.2.0 | | ||
| | **`type`** | <code>'absolute' \| 'resource' \| 'asset' \| 'base64'</code> | The type of the attachment. See the docs for explained informations. | 1.2.0 | | ||
| | **`name`** | <code>string</code> | The name of the attachment. See the docs for explained informations. Required for base64 attachements. | 1.2.0 | | ||
@@ -183,1 +196,8 @@ </docgen-api> | ||
| The full Changelog is available [here](CHANGELOG.md) | ||
| ## Troubleshooting | ||
| ### TransactionTooLargeException | ||
| When sharing data between two applications, the Android OS might throw this exception for several reasons, for example if the file is too large. | ||
| Read more [here](https://github.com/EinfachHans/capacitor-email-composer/issues/19#issuecomment-1786087158) about how to work around this problem. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Number of lines in readme file
- increased by11.7%
191
Worsened metrics
- Total package byte prevSize
- decreased by-4.45%
39137
- Dev dependency count
- increased by21.74%
28
- Lines of code
- decreased by-48.92%
331
No dependency changes