Skip to content

Commit 036949a

Browse files
Merge pull request #7 from aspose-email-cloud/develop
Develop
2 parents b1e9dcf + 1143084 commit 036949a

20 files changed

+1227
-67
lines changed

doc/EmailAccountConfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**protocolType** | **string** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | [default to undefined]
99
**host** | **string** | Email account host. | [optional] [default to undefined]
1010
**port** | **number** | Port. | [optional] [default to undefined]
11-
**socketType** | **string** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | [default to undefined]
11+
**socketType** | **string** | Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | [default to undefined]
1212
**authenticationTypes** | **Array<string>** | Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress | [optional] [default to undefined]
1313
**extraInfo** | [**Array<NameValuePair>**](NameValuePair.md) | Extra account information. | [optional] [default to undefined]
1414
**isValidated** | **boolean** | Determines that configuration validated. Set to false if validation skipped. | [default to undefined]

doc/EmailAccountRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**host** | **string** | Email account host | [default to undefined]
88
**port** | **number** | Email account port | [default to undefined]
99
**login** | **string** | Email account login | [default to undefined]
10-
**securityOptions** | **string** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | [default to undefined]
10+
**securityOptions** | **string** | Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | [default to undefined]
1111
**protocolType** | **string** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | [default to undefined]
1212
**description** | **string** | Email account description | [optional] [default to undefined]
1313
**storageFile** | [**StorageFileLocation**](StorageFileLocation.md) | A storage file location info to store email account | [default to undefined]

doc/EmailApi.md

Lines changed: 147 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,8 @@ new AiNameCompleteRequest(
296296
Name | Type | Description | Notes
297297
------------- | ------------- | ------------- | -------------
298298
**name** | **string**| A name to complete (required) |
299-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
300-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
299+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
300+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
301301
**encoding** | **string**| A character encoding name | [optional] [default to ]
302302
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
303303
**style** | **string**| Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -331,8 +331,8 @@ new AiNameExpandRequest(
331331
Name | Type | Description | Notes
332332
------------- | ------------- | ------------- | -------------
333333
**name** | **string**| A name to format (required) |
334-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
335-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
334+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
335+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
336336
**encoding** | **string**| A character encoding name | [optional] [default to ]
337337
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
338338
**style** | **string**| Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -392,8 +392,8 @@ new AiNameFormatRequest(
392392
Name | Type | Description | Notes
393393
------------- | ------------- | ------------- | -------------
394394
**name** | **string**| A name to format (required) |
395-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
396-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
395+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
396+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
397397
**encoding** | **string**| A character encoding name | [optional] [default to ]
398398
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
399399
**format** | **string**| Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats: /format/default/ (= '%t%F%m%N%L%p') /format/FN+LN/ (= '%F%L') /format/title+FN+LN/ (= '%t%F%L') /format/FN+MN+LN/ (= '%F%M%N%L') /format/title+FN+MN+LN/ (= '%t%F%M%N%L') /format/FN+MI+LN/ (= '%F%m%N%L') /format/title+FN+MI+LN/ (= '%t%F%m%N%L') /format/LN/ (= '%L') /format/title+LN/ (= '%t%L') /format/LN+FN+MN/ (= '%L,%F%M%N') /format/LN+title+FN+MN/ (= '%L,%t%F%M%N') /format/LN+FN+MI/ (= '%L,%F%m%N') /format/LN+title+FN+MI/ (= '%L,%t%F%m%N') Custom format string - custom combination of characters and the next term placeholders: '%t' - Title (prefix) '%F' - First name '%f' - First initial '%M' - Middle name(s) '%m' - Middle initial(s) '%N' - Nickname '%L' - Last name '%l' - Last initial '%p' - Postfix If no value for format option was provided, its default value is '%t%F%m%N%L%p' | [optional] [default to ]
@@ -453,8 +453,8 @@ new AiNameGenderizeRequest(
453453
Name | Type | Description | Notes
454454
------------- | ------------- | ------------- | -------------
455455
**name** | **string**| A name to parse (required) |
456-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
457-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
456+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
457+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
458458
**encoding** | **string**| A character encoding name | [optional] [default to ]
459459
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
460460
**style** | **string**| Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -515,8 +515,8 @@ Name | Type | Description | Notes
515515
------------- | ------------- | ------------- | -------------
516516
**name** | **string**| A name to match (required) |
517517
**otherName** | **string**| Another name to match (required) |
518-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
519-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
518+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
519+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
520520
**encoding** | **string**| A character encoding name | [optional] [default to ]
521521
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
522522
**style** | **string**| Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -575,8 +575,8 @@ new AiNameParseRequest(
575575
Name | Type | Description | Notes
576576
------------- | ------------- | ------------- | -------------
577577
**name** | **string**| A name to parse (required) |
578-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
579-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
578+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
579+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
580580
**encoding** | **string**| A character encoding name | [optional] [default to ]
581581
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
582582
**style** | **string**| Name writing style Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -610,8 +610,8 @@ new AiNameParseEmailAddressRequest(
610610
Name | Type | Description | Notes
611611
------------- | ------------- | ------------- | -------------
612612
**emailAddress** | **string**| Email address to parse (required) |
613-
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
614-
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
613+
**language** | **string**| An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] [default to ]
614+
**location** | **string**| A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] [default to ]
615615
**encoding** | **string**| A character encoding name | [optional] [default to ]
616616
**script** | **string**| A writing system code; starts with the ISO-15924 script name | [optional] [default to ]
617617
**style** | **string**| Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0]
@@ -1832,6 +1832,64 @@ Name | Type | Description | Notes
18321832

18331833
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
18341834

1835+
<a name="getemailclientaccount"></a>
1836+
# **getEmailClientAccount**
1837+
1838+
```typescript
1839+
public async getEmailClientAccount(requestObj: GetEmailClientAccountRequest) : Promise<{response: RequestResponse, body: EmailClientAccount; }>
1840+
```
1841+
1842+
Get email client account from storage
1843+
1844+
### Return type
1845+
1846+
`Promise<{response: RequestResponse, body: EmailClientAccount; }>`
1847+
1848+
### Request Parameters
1849+
```typescript
1850+
new GetEmailClientAccountRequest(
1851+
name,
1852+
folder,
1853+
storage)
1854+
```
1855+
1856+
Name | Type | Description | Notes
1857+
------------- | ------------- | ------------- | -------------
1858+
**name** | **string**| File name on storage |
1859+
**folder** | **string**| Folder on storage |
1860+
**storage** | **string**| Storage name |
1861+
1862+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1863+
1864+
<a name="getemailclientmultiaccount"></a>
1865+
# **getEmailClientMultiAccount**
1866+
1867+
```typescript
1868+
public async getEmailClientMultiAccount(requestObj: GetEmailClientMultiAccountRequest) : Promise<{response: RequestResponse, body: EmailClientMultiAccount; }>
1869+
```
1870+
1871+
Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\".
1872+
1873+
### Return type
1874+
1875+
`Promise<{response: RequestResponse, body: EmailClientMultiAccount; }>`
1876+
1877+
### Request Parameters
1878+
```typescript
1879+
new GetEmailClientMultiAccountRequest(
1880+
name,
1881+
folder,
1882+
storage)
1883+
```
1884+
1885+
Name | Type | Description | Notes
1886+
------------- | ------------- | ------------- | -------------
1887+
**name** | **string**| File name on storage |
1888+
**folder** | **string**| Folder on storage |
1889+
**storage** | **string**| Storage name |
1890+
1891+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1892+
18351893
<a name="getemailmodel"></a>
18361894
# **getEmailModel**
18371895

@@ -2101,6 +2159,31 @@ Name | Type | Description | Notes
21012159

21022160
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
21032161

2162+
<a name="isemailaddressdisposable"></a>
2163+
# **isEmailAddressDisposable**
2164+
2165+
```typescript
2166+
public async isEmailAddressDisposable(requestObj: IsEmailAddressDisposableRequest) : Promise<{response: RequestResponse, body: ValueTOfBoolean; }>
2167+
```
2168+
2169+
Check email address is disposable
2170+
2171+
### Return type
2172+
2173+
`Promise<{response: RequestResponse, body: ValueTOfBoolean; }>`
2174+
2175+
### Request Parameters
2176+
```typescript
2177+
new IsEmailAddressDisposableRequest(
2178+
address)
2179+
```
2180+
2181+
Name | Type | Description | Notes
2182+
------------- | ------------- | ------------- | -------------
2183+
**address** | **string**| An email address to check |
2184+
2185+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2186+
21042187
<a name="listemailfolders"></a>
21052188
# **listEmailFolders**
21062189

@@ -2361,6 +2444,56 @@ Name | Type | Description | Notes
23612444

23622445
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
23632446

2447+
<a name="saveemailclientaccount"></a>
2448+
# **saveEmailClientAccount**
2449+
2450+
```typescript
2451+
public async saveEmailClientAccount(requestObj: SaveEmailClientAccountRequest) : Promise<{response: RequestResponse, body?: any; }>
2452+
```
2453+
2454+
Create email client account file (*.account) with any of supported credentials
2455+
2456+
### Return type
2457+
2458+
`Promise<{response: RequestResponse, body?: any; }>`
2459+
2460+
### Request Parameters
2461+
```typescript
2462+
new SaveEmailClientAccountRequest(
2463+
request)
2464+
```
2465+
2466+
Name | Type | Description | Notes
2467+
------------- | ------------- | ------------- | -------------
2468+
**request** | [**StorageFileRqOfEmailClientAccount**](StorageFileRqOfEmailClientAccount.md)| Email account information |
2469+
2470+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2471+
2472+
<a name="saveemailclientmultiaccount"></a>
2473+
# **saveEmailClientMultiAccount**
2474+
2475+
```typescript
2476+
public async saveEmailClientMultiAccount(requestObj: SaveEmailClientMultiAccountRequest) : Promise<{response: RequestResponse, body?: any; }>
2477+
```
2478+
2479+
Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\".
2480+
2481+
### Return type
2482+
2483+
`Promise<{response: RequestResponse, body?: any; }>`
2484+
2485+
### Request Parameters
2486+
```typescript
2487+
new SaveEmailClientMultiAccountRequest(
2488+
request)
2489+
```
2490+
2491+
Name | Type | Description | Notes
2492+
------------- | ------------- | ------------- | -------------
2493+
**request** | [**StorageFileRqOfEmailClientMultiAccount**](StorageFileRqOfEmailClientMultiAccount.md)| Email accounts information |
2494+
2495+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2496+
23642497
<a name="saveemailmodel"></a>
23652498
# **saveEmailModel**
23662499

doc/EmailClientAccount.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
# EmailClientAccount
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**host** | **string** | Mail server host name or IP address | [default to undefined]
8+
**port** | **number** | Mail server port | [default to undefined]
9+
**securityOptions** | **string** | Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | [default to undefined]
10+
**protocolType** | **string** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | [default to undefined]
11+
**credentials** | [**EmailClientAccountCredentials**](EmailClientAccountCredentials.md) | Email client account credentials | [default to undefined]
12+
13+
14+
15+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# EmailClientAccountCredentials
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**login** | **string** | Email client account login | [default to undefined]
8+
**discriminator** | **string** | | [default to undefined]
9+
10+
11+
12+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# EmailClientAccountOauthCredentials
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**clientId** | **string** | The client ID obtained from the Google Cloud Console during application registration. | [default to undefined]
8+
**clientSecret** | **string** | The client secret obtained during application registration. | [default to undefined]
9+
**refreshToken** | **string** | OAuth 2.0 refresh token | [default to undefined]
10+
**requestUrl** | **string** | The url to obtain access token. If not specified, will try to discover from email client account host. | [optional] [default to undefined]
11+
12+
Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md)
13+
14+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# EmailClientAccountPasswordCredentials
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**password** | **string** | Email client account password | [default to undefined]
8+
9+
Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md)
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

0 commit comments

Comments
 (0)