Folder

Email client folder operations.

Most of the email protocols support grouping messages in folders.

The email client supports different functions to manage such folders:

Create a folder.
Get a list of folders.
Delete folder.

Create

Create new folder in email account. Requires:

request

Create folder request. Type: ClientFolderCreateRequest.

var request = new ClientFolderCreateRequest
{
    ParentFolder = "INBOX/SubFolder/ParentFolder",
    FolderName = "NewFolder",
    AccountLocation = new StorageFileLocation
    {
        FileName = "email.account",
        Storage = "First Storage",
        FolderPath = "file/location/folder/on/storage"
    }
};

Java

ClientFolderCreateRequest request = Models.clientFolderCreateRequest()
    .parentFolder("INBOX/SubFolder/ParentFolder")
    .folderName("NewFolder")
    .accountLocation(Models.storageFileLocation()
        .fileName("email.account")
        .storage("First Storage")
        .folderPath("file/location/folder/on/storage")
        .build())
    .build();

Python

request = models.ClientFolderCreateRequest(
    parent_folder='INBOX/SubFolder/ParentFolder',
    folder_name='NewFolder',
    account_location=models.StorageFileLocation(
        file_name='email.account',
        storage='First Storage',
        folder_path='file/location/folder/on/storage'))

Ruby

request = ClientFolderCreateRequest.new(
  parent_folder: 'INBOX/SubFolder/ParentFolder',
  folder_name: 'NewFolder',
  account_location: StorageFileLocation.new(
    file_name: 'email.account',
    storage: 'First Storage',
    folder_path: 'file/location/folder/on/storage'))

Typescript

let request = Models.clientFolderCreateRequest()
    .parentFolder('INBOX/SubFolder/ParentFolder')
    .folderName('NewFolder')
    .accountLocation(Models.storageFileLocation()
        .fileName('email.account')
        .storage('First Storage')
        .folderPath('file/location/folder/on/storage')
        .build())
    .build();

PHP

$request = Models::clientFolderCreateRequest()
    ->parentFolder('INBOX/SubFolder/ParentFolder')
    ->folderName('NewFolder')
    ->accountLocation(Models::storageFileLocation()
        ->fileName('email.account')
        ->storage('First Storage')
        ->folderPath('file/location/folder/on/storage')
        ->build())
    ->build();

await api.Client.Folder.CreateAsync(request);

Java

api.client().folder().create(request);

Python

api.client.folder.create(request)

Ruby

api.client.folder.create(request)

Typescript

await api.client.folder.create(request);

PHP

$api->client()->folder()->create($request);

Delete

Delete a folder in email account. Requires:

request

Delete folder request. Type: ClientFolderDeleteRequest.

var request = new ClientFolderDeleteRequest
{
    Folder = "INBOX/SubFolder/FolderToDelete",
    AccountLocation = new StorageFileLocation
    {
        FileName = "email.account",
        Storage = "First Storage",
        FolderPath = "file/location/folder/on/storage"
    }
};

Java

ClientFolderDeleteRequest request = Models.clientFolderDeleteRequest()
    .folder("INBOX/SubFolder/FolderToDelete")
    .accountLocation(Models.storageFileLocation()
        .fileName("email.account")
        .storage("First Storage")
        .folderPath("file/location/folder/on/storage")
        .build())
    .build();

Python

request = models.ClientFolderDeleteRequest(
    folder='INBOX/SubFolder/FolderToDelete',
    account_location=models.StorageFileLocation(
        file_name='email.account',
        storage='First Storage',
        folder_path='file/location/folder/on/storage'))

Ruby

request = ClientFolderDeleteRequest.new(
  folder: 'INBOX/SubFolder/FolderToDelete',
  account_location: StorageFileLocation.new(
    file_name: 'email.account',
    storage: 'First Storage',
    folder_path: 'file/location/folder/on/storage'))

Typescript

let request = Models.clientFolderDeleteRequest()
    .folder('INBOX/SubFolder/FolderToDelete')
    .accountLocation(Models.storageFileLocation()
        .fileName('email.account')
        .storage('First Storage')
        .folderPath('file/location/folder/on/storage')
        .build())
    .build();

PHP

$request = Models::clientFolderDeleteRequest()
    ->folder('INBOX/SubFolder/FolderToDelete')
    ->accountLocation(Models::storageFileLocation()
        ->fileName('email.account')
        ->storage('First Storage')
        ->folderPath('file/location/folder/on/storage')
        ->build())
    ->build();

await api.Client.Folder.DeleteAsync(request);

Java

api.client().folder().delete(request);

Python

api.client.folder.delete(request)

Ruby

api.client.folder.delete(request)

Typescript

await api.client.folder.delete(request);

PHP

$api->client()->folder()->delete($request);

GetList

Get folders list in email account. Returns MailServerFolderList model. Requires:

request

GetList method request. Type: ClientFolderGetListRequest.

var request = new ClientFolderGetListRequest
{ 
    Account = "email.multi.account",
    Storage = "First Storage",
    AccountStorageFolder = "email/account/location/on/storage",
    ParentFolder = "INBOX"
};

Java

ClientFolderGetListRequest request = Models.clientFolderGetListRequest()
    .account("email.multi.account")
    .storage("First Storage")
    .accountStorageFolder("email/account/location/on/storage")
    .parentFolder("INBOX")
    .build();

Python

request = models.ClientFolderGetListRequest(
    account='email.multi.account',
    storage='First Storage',
    account_storage_folder='email/account/location/on/storage',
    parent_folder='INBOX')

Ruby

request = ClientFolderGetListRequest.new(
    account: 'email.multi.account',
    storage: 'First Storage',
    account_storage_folder: 'email/account/location/on/storage',
    parent_folder: 'INBOX')

Typescript

let request = Models.ClientFolderGetListRequest()
    .account('email.multi.account')
    .storage('First Storage')
    .accountStorageFolder('email/account/location/on/storage')
    .parentFolder('INBOX')
    .build();

PHP

$request = Models::ClientFolderGetListRequest()
    ->account('email.multi.account')
    ->storage('First Storage')
    ->account_storage_folder('email/account/location/on/storage')
    ->parent_folder('INBOX')
    ->build();

var result = await api.Client.Folder.GetListAsync(request);

Java

MailServerFolderList result = api.client().folder().getList(request);

Python

result = api.client.folder.get_list(request)

Ruby

result = api.client.folder.get_list(request)

Typescript

let result = await api.client.folder.getList(request);

PHP

$result = $api->client()->folder()->getList($request);

More APIs

Account
Folder
Message
Thread