PersonalStorage.SplitIntoAsync
SplitIntoAsync(long, string, CancellationToken)
Splits the pst storage into less sized parts.
public Task SplitIntoAsync(long chunkSize, string path, CancellationToken token = default)
| Parameter | Type | Description |
|---|
| chunkSize | Int64 | The approximate size of a chunk in bytes. |
| path | String | The folder path where chunks will be created. |
| token | CancellationToken | Propagates notification that operations should be canceled. |
Exceptions
| exception | condition |
|---|
| ArgumentException | Throws when the path parameter is null or empty. |
| ArgumentException | Throws when the chunk size is less then the minimum size of pst file. |
See Also
SplitIntoAsync(long, string, string, CancellationToken)
Splits the pst storage into less sized parts.
public Task SplitIntoAsync(long chunkSize, string partFileNamePrefix, string path,
CancellationToken token = default)
| Parameter | Description |
|---|
| chunkSize | The approximate size of a chunk in bytes. |
| partFileNamePrefix | The prefix to be added to the filename of each part of pst. The folder path where chunks will be created.Propagates notification that operations should be canceled. If provided, the prefix will be added to the beginning of each file name. If not provided (null or empty), the pst parts will be created without a prefix. |
Exceptions
| exception | condition |
|---|
| ArgumentException | Throws when the path parameter is null or empty. |
| ArgumentException | Throws when the chunk size is less then the minimum size of pst file. |
The pst file names are produced using the following template: {prefix}_part{number}.pst - {prefix}: The filename prefix provided by the partFileNamePrefix parameter. If not provided, this part will be omitted. - {number}: The number of the chunk file.
See Also
SplitIntoAsync(IList<MailQuery>, string, CancellationToken)
Splits the pst storage based on criteria.
public Task SplitIntoAsync(IList<MailQuery> criteria, string path,
CancellationToken token = default)
| Parameter | Type | Description |
|---|
| criteria | IList`1 | The collection of MailQuery that represents criteria of pst splitting. |
| path | String | The folder path where chunks will be created. |
| token | CancellationToken | Propagates notification that operations should be canceled. |
Exceptions
| exception | condition |
|---|
| ArgumentException | Throws when the path parameter is null or empty. |
See Also
SplitIntoAsync(IList<MailQuery>, string, string, CancellationToken)
Splits the pst storage based on criteria.
public Task SplitIntoAsync(IList<MailQuery> criteria, string partFileNamePrefix, string path,
CancellationToken token = default)
| Parameter | Description |
|---|
| criteria | The collection of MailQuery that represents criteria of pst splitting. |
| partFileNamePrefix | The prefix to be added to the filename of each part of pst. The folder path where chunks will be created.Propagates notification that operations should be canceled. If provided, the prefix will be added to the beginning of each file name. If not provided (null or empty), the pst parts will be created without a prefix. |
Exceptions
| exception | condition |
|---|
| ArgumentException | Throws when the path parameter is null or empty. |
The pst file names are produced using the following template: {prefix}_part{number}.pst - {prefix}: The filename prefix provided by the partFileNamePrefix parameter. If not provided, this part will be omitted. - {number}: The number of the chunk file.
See Also