Skip to content

Commit d530bda

Browse files
committed
README formatting improved
1 parent 51008d5 commit d530bda

File tree

3 files changed

+39
-21
lines changed

3 files changed

+39
-21
lines changed

Model/EmailAccountRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public class EmailAccountRequest
5353
public string Login { get; set; }
5454

5555
/// <summary>
56-
/// Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
56+
/// Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
5757
/// </summary>
5858
public string SecurityOptions { get; set; }
5959

README.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,47 @@
1+
# Aspose.Email Cloud SDK for .NET [![NuGet](https://img.shields.io/nuget/v/Aspose.Email-Cloud.svg)](https://www.nuget.org/packages/Aspose.Email-Cloud/)
2+
This repository contains Aspose.Email Cloud SDK for .NET source code. This SDK allows you to work with Aspose.Email Cloud REST APIs in your .NET applications quickly and easily, with zero initial cost.
3+
4+
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")
5+
[API Reference](https://apireference.aspose.cloud/email/)
6+
7+
# Key features
18
Aspose.Email Cloud is a REST API for creating email applications that work with standard email file formats. This SDK:
29
- Lets developers manipulate different emails’ formats such as Outlook MSG, EML, VCard, and iCalendar files
310
- Has a built-in email client
411
- Supports AI functionalities:
512
- The Business card recognition
613
- The Name API for parsing and handling personal names
714

8-
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).
9-
1015
## How to use the SDK?
1116
The complete source code is available in the GIT repository.
1217
Use reference documentation, available [**here**](docs/README.md)
1318

19+
### Prerequisites
20+
21+
To use this SDK, you need:
22+
- One of supported (or compatible with supported) .NET frameworks:
23+
- .NETFramework 2.0
24+
- .NETFramework 4.5.2
25+
- .NETStandard 2.0
26+
- MonoAndroid 6.0
27+
- Xamarin.iOS 1.0
28+
- Xamarin.Mac 2.0
29+
- 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).
30+
31+
### Installation
32+
You can use SDK directly in your project via the source code or get a [NuGet Package](https://www.nuget.org/packages/Aspose.Email-Cloud/).
33+
From the Package Manager:
34+
35+
PM> Install-Package Aspose.Email-Cloud
36+
37+
Using .NET CLI:
38+
39+
dotnet add package Aspose.Email-Cloud
40+
41+
Or as a Package reference:
42+
43+
<PackageReference Include="Aspose.Email-Cloud"/>
44+
1445
### Usage examples
1546
To use the API, you should create an EmailApi object:
1647
```csharp
@@ -144,8 +175,9 @@ See examples below:
144175
var name = "John Cane";
145176
var result = await emailApi.AiNameGenderizeAsync(
146177
new AiNameGenderizeRequest(name));
147-
//the result contains a list of hypothesis about a person's gender.
148-
//all hypothesis include score, so you can use the most scored version, which will be the first in a list:
178+
// the result contains a list of hypothesis about a person's gender.
179+
// all hypothesis include score, so you can use the most scored version,
180+
// which will be the first in a list:
149181
System.Console.WriteLine(result.Value.First().Gender); //prints "Male"
150182
```
151183
</details>
@@ -228,27 +260,13 @@ System.Console.WriteLine(surName.Value); // "Cane"
228260
```
229261
</details>
230262

231-
### Install Aspose.Email for Cloud via NuGet
232-
You can use it directly in your project via the source code or get a [NuGet Package](https://www.nuget.org/packages/Aspose.Email-Cloud/).
233-
From the Package Manager:
234-
235-
PM> Install-Package Aspose.Email-Cloud
236-
237-
Using .NET CLI:
238-
239-
dotnet add package Aspose.Email-Cloud
240-
241-
Or as a Package reference:
242-
243-
<PackageReference Include="Aspose.Email-Cloud"/>
244-
245263
# Licensing
246264
All Aspose.Email Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
247265

248266
# Resources
249267
+ [**SDK Reference documentation**](docs/README.md)
250268
+ [**Website**](https://www.aspose.cloud)
251-
+ [**Product Home**](https://products.aspose.cloud/Email/cloud)
269+
+ [**Product Home**](https://products.aspose.cloud/Email)
252270
+ [**Documentation**](https://docs.aspose.cloud/display/Emailcloud/Home)
253271
+ [**API Reference**](https://apireference.aspose.cloud/email/)
254272
+ [**Free Support Forum**](https://forum.aspose.cloud/c/email)

docs/EmailAccountRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
**Host** | **string** | Email account host |
66
**Port** | **int?** | Email account port |
77
**Login** | **string** | Email account login |
8-
**SecurityOptions** | **string** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto |
8+
**SecurityOptions** | **string** | Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto |
99
**ProtocolType** | **string** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav |
1010
**Description** | **string** | Email account description | [optional]
1111
**StorageFile** | [**StorageFileLocation**](StorageFileLocation.md) | A storage file location info to store email account |

0 commit comments

Comments
 (0)