Skip to content

Commit bcdfb05

Browse files
Aspose-Email-TeamAspose-Email-Team
committed
SDK version 20.9.0.137 generated
1 parent 6d98db0 commit bcdfb05

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+345
-245
lines changed

‎README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
1-
# Aspose.Email Cloud SDK for Node.Js
1+
# Aspose.Email Cloud SDK for Node.Js
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

55
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.
66

7-
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")
8-
[API Reference](https://apireference.aspose.cloud/email/)
7+
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")
8+
[API Reference](https://apireference.aspose.cloud/email/)
99

1010
# Key features
1111
Aspose.Email Cloud is a REST API for creating email applications that work with standard email file formats. This SDK:
1212
- Lets developers manipulate different emails’ formats such as Outlook MSG, EML, VCard, and iCalendar files
1313
- Lets developers manipulate different emails' formats such as Outlook MSG, EML, VCard, and iCalendar files
1414
- Supports AI functions:
15-
- The Business card recognition
16-
- The Name API for parsing and handling personal names
15+
- The Business card recognition
16+
- The Name API for parsing and handling personal names
1717
- 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)
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)
2121
- Email configuration discovery
2222
- Disposable email address detection
2323

24-
## New features in version 20.7
25-
- New MAPI message files API with models:
26-
- `MapiMessageDto` - represents the Microsoft Outlook message.
27-
- `MapiCalendarDto` - represents the Microsoft Outlook calendar object.
28-
- `MapiContactDto` - represents the Microsoft Outlook contact information.
29-
- Improved Recurrence pattern support for CalendarDto.
24+
## New features in version 20.9
25+
26+
Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API.
27+
28+
- All SDK functions are divided into groups (Email, Calendar, Contact, Client, Ai, Mapi, etc.).
29+
- Unified file API provided for supported file types (Save, Get, Convert, AsFile, FromFile, AsMapi/AsDto).
30+
- HierarchicalObject based API is removed.
31+
- All models are stored in one folder/namespace.
32+
- The request models are simplified.
33+
34+
See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.9+Release+Notes).
3035

31-
See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.7+Release+Notes)
3236
## How to use the SDK?
3337
The complete source code is available in the GIT repository.
3438

@@ -52,7 +56,7 @@ To use this SDK, you need an App SID and an App Key; they can be looked up at [A
5256
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)
5357
From the command line:
5458

55-
npm install @asposecloud/aspose-email-cloud --save
59+
npm install @asposecloud/aspose-email-cloud --save
5660

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

@@ -71,8 +75,8 @@ Use `AiBcrParseModel` method to parse business card image to VCard DTO:
7175
```typescript
7276
var imageData = fs.readFileSync("/tmp/alex.png").toString('base64');
7377
var result = await api.aiBcrParseModel(new requests.AiBcrParseModelRequest(
74-
new models.AiBcrBase64Rq(
75-
undefined, [new models.AiBcrBase64Image(true, imageData)])));
78+
new models.AiBcrBase64Rq(
79+
undefined, [new models.AiBcrBase64Image(true, imageData)])));
7680
var contact = result.body.value[0];
7781
```
7882

‎doc/CloudStorageGroup.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Cloud file storage operations.
33

44
API | Description
55
--- | -----------
6-
[EmailCloud.cloudStorage.**file**](FileApi_list.md) |
7-
[EmailCloud.cloudStorage.**folder**](FolderApi_list.md) |
8-
[EmailCloud.cloudStorage.**storage**](StorageApi_list.md) |
6+
[EmailCloud.cloudStorage.**file**](FileApi_list.md) | File operations controller
7+
[EmailCloud.cloudStorage.**folder**](FolderApi_list.md) | Folder operations controller
8+
[EmailCloud.cloudStorage.**storage**](StorageApi_list.md) | Storage operations controller

‎doc/DiscUsage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**usedSize** | **number** | | [default to undefined]
7-
**totalSize** | **number** | | [default to undefined]
6+
**usedSize** | **number** | Application used disc space. | [default to undefined]
7+
**totalSize** | **number** | Total disc space. | [default to undefined]
88

99

1010

‎doc/ErrorDetails.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**requestId** | **string** | | [optional] [default to undefined]
7-
**date** | **Date** | | [default to undefined]
6+
**requestId** | **string** | The request id | [optional] [default to undefined]
7+
**date** | **Date** | Date | [default to undefined]
88

99

1010

‎doc/FileApi.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
public async copyFile(request: CopyFileRequest): Promise< any >
88
```
99

10-
10+
Copy file
1111

1212
### Request Parameters
1313
```typescript
@@ -21,11 +21,11 @@ new CopyFile(
2121

2222
Name | Type | Description | Notes
2323
---- | ---- | ----------- | -----
24-
**srcPath** | **string**| |
25-
**destPath** | **string**| |
26-
**srcStorageName** | **string**| | [optional]
27-
**destStorageName** | **string**| | [optional]
28-
**versionId** | **string**| | [optional]
24+
**srcPath** | **string**| Source file path e.g. &#39;/folder/file.ext&#39; |
25+
**destPath** | **string**| Destination file path |
26+
**srcStorageName** | **string**| Source storage name | [optional]
27+
**destStorageName** | **string**| Destination storage name | [optional]
28+
**versionId** | **string**| File version ID to copy | [optional]
2929

3030
### Return type
3131

@@ -39,7 +39,7 @@ Promise< any >
3939
public async deleteFile(request: DeleteFileRequest): Promise< any >
4040
```
4141

42-
42+
Delete file
4343

4444
### Request Parameters
4545
```typescript
@@ -51,9 +51,9 @@ new DeleteFile(
5151

5252
Name | Type | Description | Notes
5353
---- | ---- | ----------- | -----
54-
**path** | **string**| |
55-
**storageName** | **string**| | [optional]
56-
**versionId** | **string**| | [optional]
54+
**path** | **string**| File path e.g. &#39;/folder/file.ext&#39; |
55+
**storageName** | **string**| Storage name | [optional]
56+
**versionId** | **string**| File version ID to delete | [optional]
5757

5858
### Return type
5959

@@ -67,7 +67,7 @@ Promise< any >
6767
public async downloadFile(request: DownloadFileRequest): Promise< Buffer >
6868
```
6969

70-
70+
Download file
7171

7272
### Request Parameters
7373
```typescript
@@ -79,9 +79,9 @@ new DownloadFile(
7979

8080
Name | Type | Description | Notes
8181
---- | ---- | ----------- | -----
82-
**path** | **string**| |
83-
**storageName** | **string**| | [optional]
84-
**versionId** | **string**| | [optional]
82+
**path** | **string**| File path e.g. &#39;/folder/file.ext&#39; |
83+
**storageName** | **string**| Storage name | [optional]
84+
**versionId** | **string**| File version ID to download | [optional]
8585

8686
### Return type
8787

@@ -95,7 +95,7 @@ Promise< Buffer >
9595
public async moveFile(request: MoveFileRequest): Promise< any >
9696
```
9797

98-
98+
Move file
9999

100100
### Request Parameters
101101
```typescript
@@ -109,11 +109,11 @@ new MoveFile(
109109

110110
Name | Type | Description | Notes
111111
---- | ---- | ----------- | -----
112-
**srcPath** | **string**| |
113-
**destPath** | **string**| |
114-
**srcStorageName** | **string**| | [optional]
115-
**destStorageName** | **string**| | [optional]
116-
**versionId** | **string**| | [optional]
112+
**srcPath** | **string**| Source file path e.g. &#39;/src.ext&#39; |
113+
**destPath** | **string**| Destination file path e.g. &#39;/dest.ext&#39; |
114+
**srcStorageName** | **string**| Source storage name | [optional]
115+
**destStorageName** | **string**| Destination storage name | [optional]
116+
**versionId** | **string**| File version ID to move | [optional]
117117

118118
### Return type
119119

@@ -127,7 +127,7 @@ Promise< any >
127127
public async uploadFile(request: UploadFileRequest): Promise< FilesUploadResult >
128128
```
129129

130-
130+
Upload file
131131

132132
### Request Parameters
133133
```typescript
@@ -139,9 +139,9 @@ new UploadFile(
139139

140140
Name | Type | Description | Notes
141141
---- | ---- | ----------- | -----
142-
**path** | **string**| |
142+
**path** | **string**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. |
143143
**file** | **byte[]**| File to upload |
144-
**storageName** | **string**| | [optional]
144+
**storageName** | **string**| Storage name | [optional]
145145

146146
### Return type
147147

‎doc/FileApi_list.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.aspose.cloud/v4.0*
44

55
Method | HTTP request | Description
66
------ | ------------ | -----------
7-
[**copyFile**](FileApi.md#copyFile) | **PUT** /email/storage/file/copy/{srcPath} |
8-
[**deleteFile**](FileApi.md#deleteFile) | **DELETE** /email/storage/file/{path} |
9-
[**downloadFile**](FileApi.md#downloadFile) | **GET** /email/storage/file/{path} |
10-
[**moveFile**](FileApi.md#moveFile) | **PUT** /email/storage/file/move/{srcPath} |
11-
[**uploadFile**](FileApi.md#uploadFile) | **PUT** /email/storage/file/{path} |
7+
[**copyFile**](FileApi.md#copyFile) | **PUT** /email/storage/file/copy/{srcPath} | Copy file
8+
[**deleteFile**](FileApi.md#deleteFile) | **DELETE** /email/storage/file/{path} | Delete file
9+
[**downloadFile**](FileApi.md#downloadFile) | **GET** /email/storage/file/{path} | Download file
10+
[**moveFile**](FileApi.md#moveFile) | **PUT** /email/storage/file/move/{srcPath} | Move file
11+
[**uploadFile**](FileApi.md#uploadFile) | **PUT** /email/storage/file/{path} | Upload file

‎doc/FileVersion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**versionId** | **string** | | [optional] [default to undefined]
7-
**isLatest** | **boolean** | | [default to undefined]
6+
**versionId** | **string** | File Version ID. | [optional] [default to undefined]
7+
**isLatest** | **boolean** | Specifies whether the file is (true) or is not (false) the latest version of an file. | [default to undefined]
88

99
Parent class: [StorageFile](StorageFile.md)
1010

‎doc/FileVersions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**value** | [**Array&lt;FileVersion&gt;**](FileVersion.md) | | [optional] [default to undefined]
6+
**value** | [**Array&lt;FileVersion&gt;**](FileVersion.md) | File versions FileVersion. | [optional] [default to undefined]
77

88

99

‎doc/FilesList.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**value** | [**Array&lt;StorageFile&gt;**](StorageFile.md) | | [optional] [default to undefined]
6+
**value** | [**Array&lt;StorageFile&gt;**](StorageFile.md) | Files and folders contained by folder StorageFile. | [optional] [default to undefined]
77

88

99

‎doc/FilesUploadResult.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**uploaded** | **Array&lt;string&gt;** | | [optional] [default to undefined]
7-
**errors** | **Array&lt;Error&gt;** | | [optional] [default to undefined]
6+
**uploaded** | **Array&lt;string&gt;** | List of uploaded file names | [optional] [default to undefined]
7+
**errors** | **Array&lt;Error&gt;** | List of errors. | [optional] [default to undefined]
88

99

1010

0 commit comments

Comments
 (0)