Skip to content

Commit b707c94

Browse files
Aspose-Email-TeamAspose-Email-Team
committed
SDK version 20.9.0.138 generated
1 parent bcdfb05 commit b707c94

File tree

1 file changed

+28
-56
lines changed

1 file changed

+28
-56
lines changed

‎README.md‎

Lines changed: 28 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
# Aspose.Email Cloud SDK for Node.Js
1+
# Manage Emails in Cloud via Node.Js/Typescript REST SDK
22

33
[![npm](https://img.shields.io/npm/v/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) [![License](https://img.shields.io/github/license/aspose-email-cloud/aspose-email-cloud-node)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) [![node](https://img.shields.io/node/v/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) [![types](https://img.shields.io/npm/types/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) ![tests](https://github.com/aspose-email-cloud/aspose-email-cloud-node/workflows/tests/badge.svg)
44

5-
This repository contains Aspose.Email Cloud SDK for Node.Js source code. This SDK allows you to work with Aspose.Email Cloud REST APIs in your Node.Js applications quickly and easily, with zero initial cost.
5+
[Aspose.Email Cloud SDK for Node.Js/Typescript](https://products.aspose.cloud/email/nodejs) is a REST API SDK for creating email applications that work with standard email file formats such as Outlook MSG, EML, iCalendar files and VCard.
66

7-
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")
7+
This SDK allows you to work with Aspose.Email Cloud REST APIs in your Node.Js applications quickly and easily, with zero initial cost.
8+
9+
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family)
810
[API Reference](https://apireference.aspose.cloud/email/)
911

10-
# Key features
12+
# Cloud Email Processing Features
1113
Aspose.Email Cloud is a REST API for creating email applications that work with standard email file formats. This SDK:
12-
- Lets developers manipulate different emails’ formats such as Outlook MSG, EML, VCard, and iCalendar files
13-
- Lets developers manipulate different emails' formats such as Outlook MSG, EML, VCard, and iCalendar files
14+
- Lets developers manipulate different emails' formats such as Outlook MSG, EML, VCard, and iCalendar files.
1415
- Supports AI functions:
15-
- The Business card recognition
16-
- The Name API for parsing and handling personal names
16+
- The Business card recognition.
17+
- The Name API for parsing and handling personal names.
1718
- Has a built-in email client. This client provides:
18-
- Unified REST API for different email protocols: IMAP, POP3, SMTP, EWS, WebDav
19-
- Virtual multi-account
20-
- Message threads (POP3 accounts are also supported)
21-
- Email configuration discovery
22-
- Disposable email address detection
19+
- Unified REST API for different email protocols: IMAP, POP3, SMTP, EWS, WebDav.
20+
- Virtual multi-account.
21+
- Message threads (POP3 accounts are also supported).
22+
- Email configuration discovery.
23+
- Disposable email address detection.
2324

2425
## New features in version 20.9
2526

@@ -34,69 +35,40 @@ Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API.
3435
See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.9+Release+Notes).
3536

3637
## How to use the SDK?
37-
The complete source code is available in the GIT repository.
38+
The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-node/tree/master/src).
3839

39-
Use [SDK tutorials](https://docs.aspose.cloud/display/emailcloud/SDK+Tutorials):
40-
- [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup) - installation, account setup, first API calls
41-
- [Business Cards Recognition API](https://docs.aspose.cloud/display/emailcloud/Business+Cards+Recognition+API) - convert captured business cards and name card images, into a vCard format
42-
- [Working with Name API](https://docs.aspose.cloud/display/emailcloud/Working+with+Name+API) - format, genderize, compare, parse, autocomplete names
43-
- [Email Message Files](https://docs.aspose.cloud/display/emailcloud/Email+Message+Files) - Convert EML to MSG and back, edit EML files, etc.
44-
- [Quick Start With iCalendar API](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+iCalendar+API) - Crate and edit iCalendar files
45-
- [Quick Start With VCard API](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+VCard+API) - Create and edit VCard files, business card recognition
46-
- [Quick Start With Email Client](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+Email+Client) - Setup builtin email client, search/fetch/send/move/delete messages
47-
- [Email Client Threads](https://docs.aspose.cloud/display/emailcloud/Email+Client+Threads) - Fetch/Move/Delete email message threads using builtin email client
48-
- [File converters](https://docs.aspose.cloud/display/emailcloud/Convert+Email%2C+Calendar+and+Contact+Files)
40+
Use [SDK tutorials](https://docs.aspose.cloud/display/emailcloud/SDK+Tutorials).
4941

50-
SDK reference documentation is available in [this README](doc/README.md)
42+
SDK reference documentation is available in [this README](https://github.com/aspose-email-cloud/aspose-email-cloud-node/blob/master/doc/README.md).
5143

5244
### Prerequisites
5345
To use this SDK, you need an App SID and an App Key; they can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (it requires free registration in Aspose Cloud for this).
5446

5547
### Installation
56-
You can use it directly in your project via the source code or get a [npm package](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud)
48+
You can use it directly in your project via the source code or get a [npm package](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud).
5749
From the command line:
5850

59-
npm install @asposecloud/aspose-email-cloud --save
51+
npm install @asposecloud/aspose-email-cloud --save
6052

61-
See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup)
53+
See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup).
6254

6355
### Usage examples
64-
To use the API, you should create an EmailApi object:
56+
To use the API, you should create an EmailCloud object:
6557
```typescript
6658
var appKey = "Your App Key";
6759
var appSid = "Your App SID";
68-
var api = new EmailApi(appSid, appKey);
60+
var api = new EmailCloud(appSid, appKey);
6961
```
7062

7163
#### Business cards recognition API
7264

73-
Use `AiBcrParseModel` method to parse business card image to VCard DTO:
65+
Use `AiBcrApi.parse` method to parse business card image to VCard DTO:
7466

7567
```typescript
76-
var imageData = fs.readFileSync("/tmp/alex.png").toString('base64');
77-
var result = await api.aiBcrParseModel(new requests.AiBcrParseModelRequest(
78-
new models.AiBcrBase64Rq(
79-
undefined, [new models.AiBcrBase64Image(true, imageData)])));
80-
var contact = result.body.value[0];
68+
var imageData = fs.readFileSync("path/to/image/to/parse.png");
69+
var result = await api.ai.bcr.parse(new AiBcrParseRequest(
70+
imageData, undefined, undefined, true));
71+
var contact = result.value[0];
8172
```
8273

83-
See more details [here](https://docs.aspose.cloud/display/emailcloud/Parse+Image+To+VCard+File) and [here](https://docs.aspose.cloud/display/emailcloud/Business+Cards+Recognition+API)
84-
85-
# Licensing
86-
All Aspose.Email Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
87-
88-
# Resources
89-
+ [**SDK reference documentation**](doc/README.md)
90-
+ [**Website**](https://www.aspose.cloud)
91-
+ [**Product Home**](https://products.aspose.cloud/Email/cloud)
92-
+ [**Documentation**](https://docs.aspose.cloud/display/Emailcloud/Home)
93-
+ [**API Reference**](https://apireference.aspose.cloud/email/)
94-
+ [**Free Support Forum**](https://forum.aspose.cloud/c/email)
95-
+ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
96-
+ [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose-email-cloud/)
97-
+ [**Git repository: Aspose.Email Cloud SDK for .Net**](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet)
98-
+ [**Git repository: Aspose.Email Cloud SDK for Ruby**](https://github.com/aspose-email-cloud/aspose-email-cloud-ruby)
99-
+ [**Git repository: Aspose.Email Cloud SDK for Python**](https://github.com/aspose-email-cloud/aspose-email-cloud-python)
100-
+ [**Git repository: Aspose.Email Cloud SDK for PHP**](https://github.com/aspose-email-cloud/aspose-email-cloud-php)
101-
+ [**Git repository: Aspose.Email Cloud SDK for Typescript**](https://github.com/aspose-email-cloud/aspose-email-cloud-node)
102-
+ [**Git repository: Aspose.Email Cloud SDK for Java**](https://github.com/aspose-email-cloud/aspose-email-cloud-java)
74+
[Product Page](https://products.aspose.cloud/email/nodejs) | [Documentation](https://docs.aspose.cloud/display/Emailcloud/Home) | [Demo](https://products.aspose.app/email/family) | [API Reference](https://apireference.aspose.cloud/email/) | [Blog](https://blog.aspose.cloud/category/email/) | [Free support](https://forum.aspose.cloud/c/email) | [Free trial](https://dashboard.aspose.cloud/#/apps)

0 commit comments

Comments
 (0)