npm i --save @nativescript/email
- 版本:2.1.0
- GitHub:
- NPM: https://npmjs.net.cn/package/%40nativescript%2Femail
- 下载量
- 昨天: 44
- 上周: 376
- 上个月: 1886
@nativescript/Email
您可以使用此插件来编写电子邮件,手动编辑用户草稿,并发送它。
注意:此插件依赖于默认的邮件应用。如果您希望回退到第三方客户端应用(如 Gmail 或 Outlook),请检查其可用性,如果不可用,请使用类似 Social Share 插件 的解决方案。
安装
npm install @nativescript/email
用法
导入
一旦安装了插件,下一步就是在使用它之前导入它。
import * as email from '@nativescript/email';
// or
import { compose } from '@nativescript/email';
// or even
import { compose as composeEmail } from '@nativescript/email';
检查可用性
要检查设备上是否安装了邮件应用,请调用 available
方法。
email.available().then((avail: boolean) => {
console.log('Email available? ' + avail);
});
编写电子邮件
要编写电子邮件,请使用 compose
方法。
// let's first create a File object
import { knownFolders } from '@nativescript/core';
var appPath = knownFolders.currentApp().path;
var logoPath = appPath + '/res/telerik-logo.png';
email
.compose({
subject: 'Yo',
body: 'Hello <strong>dude</strong> :)',
to: ['[email protected]', '[email protected]'],
cc: ['[email protected]'],
bcc: ['[email protected]', '[email protected]'],
attachments: [
{
fileName: 'arrow1.png',
path: 'base64://iVBORw0KGgoAAAANSUhEUgAAABYAAAAoCAYAAAD6xArmAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAHGlET1QAAAACAAAAAAAAABQAAAAoAAAAFAAAABQAAAB5EsHiAAAAAEVJREFUSA1iYKAimDhxYjwIU9FIBgaQgZMmTfoPwlOmTJGniuHIhlLNxaOGwiNqNEypkwlGk9RokoIUfaM5ijo5Clh9AAAAAP//ksWFvgAAAEFJREFUY5g4cWL8pEmT/oMwiM1ATTBqONbQHA2W0WDBGgJYBUdTy2iwYA0BrILDI7VMmTJFHqv3yBUEBQsIg/QDAJNpcv6v+k1ZAAAAAElFTkSuQmCC',
mimeType: 'image/png',
},
{
fileName: 'telerik-logo.png',
path: logoPath,
mimeType: 'image/png',
},
],
})
.then(
function () {
console.log('Email composer closed');
},
function (err) {
console.log('Error: ' + err);
}
);
API
方法
名称 | 返回类型 | 描述 |
---|---|---|
available() |
Promise<boolean> |
检查邮件应用的可用性。 |
compose(options: ComposeOptions) |
Promise<boolean> |
编写并发送 ComposeOptions 电子邮件。 |
附件
名称 | 类型 | 描述 |
---|---|---|
fileName |
string |
附件使用的名称。 示例:fileName: 'Cute-Kitten.png' |
path |
string |
指向要附加的文件的路径。 |
mimeType |
string |
(iOS-only )用于帮助 iOS 设备确定如何发送文件。示例:mimeType: 'image/png' |
ComposeOptions
名称 | 类型 | 描述 |
---|---|---|
subject |
string |
可选:电子邮件的主题。 |
body |
string |
可选:电子邮件的主体。插件将自动处理纯文本和 HTML 电子邮件内容。 |
body |
string |
可选:电子邮件的主体。插件将自动处理纯文本和 HTML 电子邮件内容。 |
to |
string[] |
可选:直接收件人的电子邮件地址数组。在 Android 上仅使用数组中的第一个项。 |
cc |
string[] |
可选:收件人列表中的 cc 收件人的电子邮件地址数组。 |
bcc |
string[] |
可选:收件人列表中的 bcc 收件人的电子邮件地址数组。 |
attachments |
Array<Attachment> | 要附加到电子邮件的文件。 |
iosViewController |
any |
可选:(iOS-only ) 从 compose 打开的 iOS 视图控制器。 |
与 Angular 一起使用
查看 这个教程 (YouTube) 了解如何在 NativeScript-Angular 应用中使用此插件。
已知问题
由于 iOS 的限制,您无法在 iOS 模拟器上测试此插件。为了避免崩溃,当在 iOS 模拟器上调用 available
时,此插件返回 false
。
许可证
Apache 许可证版本 2.0