插件
电子邮件
@nativescript/Email
内容
简介
一个用于撰写电子邮件的插件,允许用户手动编辑草稿并发送。
注意
此插件依赖于默认的邮件应用。如果您希望回退到第三方客户端应用(如 Gmail 或 Outlook),请检查可用性,如果不可用,请使用诸如 社交分享插件之类的解决方案。
安装
要安装此插件,请在项目根目录中运行以下命令
cli
npm install @nativescript/email
使用 @nativescript/email
检查可用性
要检查设备是否安装了邮件应用,请调用 available
方法。
ts
import { available() } from '@nativescript/email';
available().then((avail: boolean) => {
console.log('Email available? ' + avail);
});
撰写电子邮件
要撰写电子邮件,请使用 compose
方法。
js
import { compose } from '@nativescript/email'
// first create a File object
import { knownFolders } from '@nativescript/core'
var appPath = knownFolders.currentApp().path
var logoPath = appPath + '/res/telerik-logo.png'
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 电子邮件。 |
与 Angular 结合使用
查看 此教程 (YouTube),了解如何在 NativeScript-Angular 应用中使用此插件。
API
函数
函数 | 返回类型 | 描述 |
---|---|---|
available() | Promise<boolean> | 检查邮件应用的可用性。 |
compose(options: ComposeOptions) | Promise<boolean> | 撰写并发送 ComposeOptions 电子邮件。 |
ComposeOptions
名称 | 类型 | 描述 |
---|---|---|
subject | string | 可选:电子邮件的主题。 |
body | string | 可选:电子邮件的正文。插件将自动处理纯文本和 HTML 电子邮件内容。 |
body | string | 可选:电子邮件的正文。插件将自动处理纯文本和 HTML 电子邮件内容。 |
to | string[] | 可选:直接收件人的电子邮件地址数组。在 Android 上,仅使用数组中的第一个项目。 |
cc | string[] | 可选:抄送收件人的电子邮件地址数组。 |
bcc | string[] | 可选:密件抄送收件人的电子邮件地址数组。 |
attachments | Array<附件> | 要附加到电子邮件的文件。 |
iosViewController | any | 可选:(仅限 iOS ) 用于打开 compose 的 iOS 视图控制器。 |
附件
名称 | 类型 | 描述 |
---|---|---|
fileName | string | 用于附件的名称。 示例:fileName: 'Cute-Kitten.png' |
path | string | 要附加的文件的路径。 |
mimeType | string | (仅限 iOS ) 用于帮助 iOS 设备确定如何发送文件。示例:mimeType: 'image/png' |
已知问题
- 在 iOS 上,由于 iOS 的限制,您无法使用模拟器测试此插件。为了防止崩溃,当在 iOS 模拟器上调用
available
时,此插件将返回false
。
许可证
Apache 许可证版本 2.0