diff --git a/README.md b/README.md index 0d95ba0..da9002e 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,16 @@ Aspose.Email Cloud is a REST API for creating email applications that work with - Email configuration discovery. - Disposable email address detection. -## New features in version 20.9 +## New features in version 20.10 -Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API. +Aspose.Email Cloud 20.10.0 comes with SDK improvements: -- All SDK functions are divided into groups (Email, Calendar, Contact, Client, Ai, Mapi, etc.). -- Unified file API provided for supported file types (Save, Get, Convert, AsFile, FromFile, AsMapi/AsDto). -- HierarchicalObject based API is removed. -- All models are stored in one folder/namespace. -- The request models are simplified. +- Typescript, PHP, Java SDKs now have model builders to simplify their initialization. +- All SDK methods now have code examples with parameters initialization. +- Some models now have initialization examples for all SDKs. +- SDK reference documentation with examples now available at url [docs.aspose.cloud/email/reference-api](https://docs.aspose.cloud/email/reference-api/) -See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-9-release-notes/). +See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-10-release-notes/). ## How to use the SDK? The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-python/tree/master/sdk/AsposeEmailCloudSdk). diff --git a/sdk/AsposeEmailCloudSdk/__init__.py b/sdk/AsposeEmailCloudSdk/__init__.py index 7217a7d..26967d2 100644 --- a/sdk/AsposeEmailCloudSdk/__init__.py +++ b/sdk/AsposeEmailCloudSdk/__init__.py @@ -296,13 +296,8 @@ from AsposeEmailCloudSdk.models.storage_exists_request import StorageExistsRequest # EmailCloud imports - from AsposeEmailCloudSdk.api.mapi_group import MapiGroup - from AsposeEmailCloudSdk.api.client_group import ClientGroup - from AsposeEmailCloudSdk.api.ai_group import AiGroup - from AsposeEmailCloudSdk.api.cloud_storage_group import CloudStorageGroup - from AsposeEmailCloudSdk.api.email_cloud import EmailCloud \ No newline at end of file diff --git a/sdk/AsposeEmailCloudSdk/api/__init__.py b/sdk/AsposeEmailCloudSdk/api/__init__.py index 891e952..884b175 100644 --- a/sdk/AsposeEmailCloudSdk/api/__init__.py +++ b/sdk/AsposeEmailCloudSdk/api/__init__.py @@ -45,16 +45,9 @@ from AsposeEmailCloudSdk.api.mapi_message_api import MapiMessageApi from AsposeEmailCloudSdk.api.storage_api import StorageApi - - # EmailCloud imports - from AsposeEmailCloudSdk.api.mapi_group import MapiGroup - from AsposeEmailCloudSdk.api.client_group import ClientGroup - from AsposeEmailCloudSdk.api.ai_group import AiGroup - from AsposeEmailCloudSdk.api.cloud_storage_group import CloudStorageGroup - from AsposeEmailCloudSdk.api.email_cloud import EmailCloud diff --git a/sdk/AsposeEmailCloudSdk/api/ai_bcr_api.py b/sdk/AsposeEmailCloudSdk/api/ai_bcr_api.py index 624ee6b..1542ab4 100644 --- a/sdk/AsposeEmailCloudSdk/api/ai_bcr_api.py +++ b/sdk/AsposeEmailCloudSdk/api/ai_bcr_api.py @@ -38,7 +38,7 @@ class AiBcrApi(ApiBase): def __init__(self, api_client): super(AiBcrApi, self).__init__(api_client) - + def parse(self, request: AiBcrParseRequest) -> ContactList: """Parse images to vCard document models @@ -96,7 +96,7 @@ def parse(self, request: AiBcrParseRequest) -> ContactList: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'ContactList') - + def parse_storage(self, request: AiBcrParseStorageRequest) -> StorageFileLocationList: """Parse images from storage to vCard files @@ -125,3 +125,4 @@ def parse_storage(self, request: AiBcrParseStorageRequest) -> StorageFileLocatio http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'StorageFileLocationList') + diff --git a/sdk/AsposeEmailCloudSdk/api/ai_group.py b/sdk/AsposeEmailCloudSdk/api/ai_group.py index 409071f..4c14461 100644 --- a/sdk/AsposeEmailCloudSdk/api/ai_group.py +++ b/sdk/AsposeEmailCloudSdk/api/ai_group.py @@ -1,4 +1,3 @@ - # coding: utf-8 # ---------------------------------------------------------------------------- # @@ -28,28 +27,25 @@ from __future__ import absolute_import from AsposeEmailCloudSdk.api import * + class AiGroup(object): """ AI powered operations. """ def __init__(self, api_client): - self._bcr = AiBcrApi(api_client) - self._name = AiNameApi(api_client) - - + @property def bcr(self) -> AiBcrApi: """ AI Business card recognition operations. """ return self._bcr - + @property def name(self) -> AiNameApi: """ AI Name operations. """ return self._name - diff --git a/sdk/AsposeEmailCloudSdk/api/ai_name_api.py b/sdk/AsposeEmailCloudSdk/api/ai_name_api.py index e1c09ae..19c4627 100644 --- a/sdk/AsposeEmailCloudSdk/api/ai_name_api.py +++ b/sdk/AsposeEmailCloudSdk/api/ai_name_api.py @@ -38,7 +38,7 @@ class AiNameApi(ApiBase): def __init__(self, api_client): super(AiNameApi, self).__init__(api_client) - + def complete(self, request: AiNameCompleteRequest) -> AiNameWeightedVariants: """The call proposes k most probable names for given starting characters. @@ -112,7 +112,7 @@ def complete(self, request: AiNameCompleteRequest) -> AiNameWeightedVariants: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameWeightedVariants') - + def expand(self, request: AiNameExpandRequest) -> AiNameWeightedVariants: """Expands a person's name into a list of possible alternatives using options for expanding instructions. @@ -186,7 +186,7 @@ def expand(self, request: AiNameExpandRequest) -> AiNameWeightedVariants: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameWeightedVariants') - + def expand_parsed(self, request: AiNameParsedRequest) -> AiNameWeightedVariants: """Expands a person's parsed name into a list of possible alternatives using options for expanding instructions. @@ -215,7 +215,7 @@ def expand_parsed(self, request: AiNameParsedRequest) -> AiNameWeightedVariants: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'AiNameWeightedVariants') - + def format(self, request: AiNameFormatRequest) -> AiNameFormatted: """Formats a person's name in correct case and name order using options for formatting instructions. @@ -295,7 +295,7 @@ def format(self, request: AiNameFormatRequest) -> AiNameFormatted: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameFormatted') - + def format_parsed(self, request: AiNameParsedRequest) -> AiNameFormatted: """Formats a person's parsed name in correct case and name order using options for formatting instructions. @@ -324,7 +324,7 @@ def format_parsed(self, request: AiNameParsedRequest) -> AiNameFormatted: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'AiNameFormatted') - + def genderize(self, request: AiNameGenderizeRequest) -> AiNameGenderHypothesisList: """Detect person's gender from name string. @@ -398,7 +398,7 @@ def genderize(self, request: AiNameGenderizeRequest) -> AiNameGenderHypothesisLi collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameGenderHypothesisList') - + def genderize_parsed(self, request: AiNameParsedRequest) -> AiNameGenderHypothesisList: """Detect person's gender from parsed name. @@ -427,7 +427,7 @@ def genderize_parsed(self, request: AiNameParsedRequest) -> AiNameGenderHypothes http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'AiNameGenderHypothesisList') - + def match(self, request: AiNameMatchRequest) -> AiNameMatchResult: """Compare people's names. Uses options for comparing instructions. @@ -510,7 +510,7 @@ def match(self, request: AiNameMatchRequest) -> AiNameMatchResult: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameMatchResult') - + def match_parsed(self, request: AiNameMatchParsedRequest) -> AiNameMatchResult: """Compare people's parsed names and attributes. Uses options for comparing instructions. @@ -539,7 +539,7 @@ def match_parsed(self, request: AiNameMatchParsedRequest) -> AiNameMatchResult: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'AiNameMatchResult') - + def parse(self, request: AiNameParseRequest) -> AiNameComponentList: """Parse name to components. @@ -613,7 +613,7 @@ def parse(self, request: AiNameParseRequest) -> AiNameComponentList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameComponentList') - + def parse_email_address(self, request: AiNameParseEmailAddressRequest) -> AiNameExtractedList: """Parse person's name out of an email address. @@ -687,3 +687,4 @@ def parse_email_address(self, request: AiNameParseEmailAddressRequest) -> AiName collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AiNameExtractedList') + diff --git a/sdk/AsposeEmailCloudSdk/api/calendar_api.py b/sdk/AsposeEmailCloudSdk/api/calendar_api.py index 00d385e..24df237 100644 --- a/sdk/AsposeEmailCloudSdk/api/calendar_api.py +++ b/sdk/AsposeEmailCloudSdk/api/calendar_api.py @@ -38,7 +38,7 @@ class CalendarApi(ApiBase): def __init__(self, api_client): super(CalendarApi, self).__init__(api_client) - + def as_alternate(self, request: CalendarAsAlternateRequest) -> AlternateView: """Convert iCalendar to AlternateView @@ -67,7 +67,7 @@ def as_alternate(self, request: CalendarAsAlternateRequest) -> AlternateView: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'AlternateView') - + def as_file(self, request: CalendarAsFileRequest) -> str: """Converts calendar model to specified format and returns as file. @@ -96,7 +96,7 @@ def as_file(self, request: CalendarAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def as_mapi(self, calendar_dto: CalendarDto) -> MapiCalendarDto: """Converts CalendarDto to MapiCalendarDto. @@ -125,7 +125,7 @@ def as_mapi(self, calendar_dto: CalendarDto) -> MapiCalendarDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiCalendarDto') - + def convert(self, request: CalendarConvertRequest) -> str: """Converts calendar document to specified format and returns as file. @@ -174,7 +174,7 @@ def convert(self, request: CalendarConvertRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: CalendarFromFileRequest) -> CalendarDto: """Converts calendar document to a model representation. @@ -214,7 +214,7 @@ def from_file(self, request: CalendarFromFileRequest) -> CalendarDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'CalendarDto') - + def get(self, request: CalendarGetRequest) -> CalendarDto: """Get calendar file from storage. @@ -270,7 +270,7 @@ def get(self, request: CalendarGetRequest) -> CalendarDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'CalendarDto') - + def get_as_alternate(self, request: CalendarGetAsAlternateRequest) -> AlternateView: """Get iCalendar from storage as AlternateView @@ -341,7 +341,7 @@ def get_as_alternate(self, request: CalendarGetAsAlternateRequest) -> AlternateV collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'AlternateView') - + def get_as_file(self, request: CalendarGetAsFileRequest) -> str: """Converts calendar document from storage to specified format and returns as file. @@ -406,7 +406,7 @@ def get_as_file(self, request: CalendarGetAsFileRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'file') - + def get_list(self, request: CalendarGetListRequest) -> CalendarStorageList: """Get iCalendar list from storage folder. @@ -468,7 +468,7 @@ def get_list(self, request: CalendarGetListRequest) -> CalendarStorageList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'CalendarStorageList') - + def save(self, request: CalendarSaveRequest): """Save iCalendar @@ -497,3 +497,4 @@ def save(self, request: CalendarSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/client_account_api.py b/sdk/AsposeEmailCloudSdk/api/client_account_api.py index cdd11fb..e05e806 100644 --- a/sdk/AsposeEmailCloudSdk/api/client_account_api.py +++ b/sdk/AsposeEmailCloudSdk/api/client_account_api.py @@ -38,7 +38,7 @@ class ClientAccountApi(ApiBase): def __init__(self, api_client): super(ClientAccountApi, self).__init__(api_client) - + def get(self, request: ClientAccountGetRequest) -> EmailClientAccount: """Get email client account from storage. @@ -94,7 +94,7 @@ def get(self, request: ClientAccountGetRequest) -> EmailClientAccount: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailClientAccount') - + def get_multi(self, request: ClientAccountGetMultiRequest) -> EmailClientMultiAccount: """Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". @@ -150,7 +150,7 @@ def get_multi(self, request: ClientAccountGetMultiRequest) -> EmailClientMultiAc collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailClientMultiAccount') - + def save(self, request: ClientAccountSaveRequest): """Create/update email client account file (*.account) with credentials @@ -179,7 +179,7 @@ def save(self, request: ClientAccountSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def save_multi(self, request: ClientAccountSaveMultiRequest): """Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". @@ -208,3 +208,4 @@ def save_multi(self, request: ClientAccountSaveMultiRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/client_folder_api.py b/sdk/AsposeEmailCloudSdk/api/client_folder_api.py index ea881cd..815a3ec 100644 --- a/sdk/AsposeEmailCloudSdk/api/client_folder_api.py +++ b/sdk/AsposeEmailCloudSdk/api/client_folder_api.py @@ -38,7 +38,7 @@ class ClientFolderApi(ApiBase): def __init__(self, api_client): super(ClientFolderApi, self).__init__(api_client) - + def create(self, request: ClientFolderCreateRequest): """Create new folder in email account @@ -67,7 +67,7 @@ def create(self, request: ClientFolderCreateRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def delete(self, request: ClientFolderDeleteRequest): """Delete a folder in email account @@ -96,7 +96,7 @@ def delete(self, request: ClientFolderDeleteRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'DELETE', None) - + def get_list(self, request: ClientFolderGetListRequest) -> MailServerFolderList: """Get folders list in email account @@ -158,3 +158,4 @@ def get_list(self, request: ClientFolderGetListRequest) -> MailServerFolderList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MailServerFolderList') + diff --git a/sdk/AsposeEmailCloudSdk/api/client_group.py b/sdk/AsposeEmailCloudSdk/api/client_group.py index 4cb5bf8..20ce790 100644 --- a/sdk/AsposeEmailCloudSdk/api/client_group.py +++ b/sdk/AsposeEmailCloudSdk/api/client_group.py @@ -1,4 +1,3 @@ - # coding: utf-8 # ---------------------------------------------------------------------------- # @@ -28,46 +27,41 @@ from __future__ import absolute_import from AsposeEmailCloudSdk.api import * + class ClientGroup(object): """ Builtin Email client operations. """ def __init__(self, api_client): - self._account = ClientAccountApi(api_client) - self._folder = ClientFolderApi(api_client) - self._message = ClientMessageApi(api_client) - self._thread = ClientThreadApi(api_client) - - + @property def account(self) -> ClientAccountApi: """ Email server account for built-in client operations. """ return self._account - + @property def folder(self) -> ClientFolderApi: """ Email client folder operations. """ return self._folder - + @property def message(self) -> ClientMessageApi: """ Email client message operations. """ return self._message - + @property def thread(self) -> ClientThreadApi: """ Email client thread operations. """ return self._thread - diff --git a/sdk/AsposeEmailCloudSdk/api/client_message_api.py b/sdk/AsposeEmailCloudSdk/api/client_message_api.py index 98ddd73..db425f1 100644 --- a/sdk/AsposeEmailCloudSdk/api/client_message_api.py +++ b/sdk/AsposeEmailCloudSdk/api/client_message_api.py @@ -38,7 +38,7 @@ class ClientMessageApi(ApiBase): def __init__(self, api_client): super(ClientMessageApi, self).__init__(api_client) - + def append(self, request: ClientMessageAppendRequest) -> ValueTOfString: """Add email message to specified folder in email account. @@ -67,7 +67,7 @@ def append(self, request: ClientMessageAppendRequest) -> ValueTOfString: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'POST', 'ValueTOfString') - + def append_file(self, request: ClientMessageAppendFileRequest) -> ValueTOfString: """Add email message from file to specified folder in email account. @@ -146,7 +146,7 @@ def append_file(self, request: ClientMessageAppendFileRequest) -> ValueTOfString collection_formats, auth_settings) return self._make_request(http_request_object, 'POST', 'ValueTOfString') - + def delete(self, request: ClientMessageDeleteRequest): """Delete message. @@ -175,7 +175,7 @@ def delete(self, request: ClientMessageDeleteRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'DELETE', None) - + def fetch(self, request: ClientMessageFetchRequest) -> MailMessageBase: """Fetch message from email account @@ -258,7 +258,7 @@ def fetch(self, request: ClientMessageFetchRequest) -> MailMessageBase: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MailMessageBase') - + def fetch_file(self, request: ClientMessageFetchFileRequest) -> str: """Fetch message as file from email account @@ -335,7 +335,7 @@ def fetch_file(self, request: ClientMessageFetchFileRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'file') - + def list(self, request: ClientMessageListRequest) -> MailMessageBaseList: """Get messages from folder, filtered by query @@ -425,7 +425,7 @@ def list(self, request: ClientMessageListRequest) -> MailMessageBaseList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MailMessageBaseList') - + def move(self, request: ClientMessageMoveRequest): """Move message to another folder. @@ -454,7 +454,7 @@ def move(self, request: ClientMessageMoveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def send(self, request: ClientMessageSendRequest): """Send an email specified by model in request. @@ -483,7 +483,7 @@ def send(self, request: ClientMessageSendRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'POST', None) - + def send_file(self, request: ClientMessageSendFileRequest): """Send an email file. @@ -550,7 +550,7 @@ def send_file(self, request: ClientMessageSendFileRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'POST', None) - + def set_is_read(self, request: ClientMessageSetIsReadRequest): """Mark message as read or unread. @@ -579,3 +579,4 @@ def set_is_read(self, request: ClientMessageSetIsReadRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/client_thread_api.py b/sdk/AsposeEmailCloudSdk/api/client_thread_api.py index 29ada7c..1b18ad7 100644 --- a/sdk/AsposeEmailCloudSdk/api/client_thread_api.py +++ b/sdk/AsposeEmailCloudSdk/api/client_thread_api.py @@ -38,7 +38,7 @@ class ClientThreadApi(ApiBase): def __init__(self, api_client): super(ClientThreadApi, self).__init__(api_client) - + def delete(self, request: ClientThreadDeleteRequest): """Delete thread by id. All messages from thread will also be deleted. @@ -67,7 +67,7 @@ def delete(self, request: ClientThreadDeleteRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'DELETE', None) - + def get_list(self, request: ClientThreadGetListRequest) -> EmailThreadList: """Get message threads from folder. All messages are partly fetched (without email body and some other fields). @@ -144,7 +144,7 @@ def get_list(self, request: ClientThreadGetListRequest) -> EmailThreadList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailThreadList') - + def get_messages(self, request: ClientThreadGetMessagesRequest) -> EmailList: """Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned. @@ -215,7 +215,7 @@ def get_messages(self, request: ClientThreadGetMessagesRequest) -> EmailList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailList') - + def move(self, request: ClientThreadMoveRequest): """Move thread to another folder. @@ -244,7 +244,7 @@ def move(self, request: ClientThreadMoveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def set_is_read(self, request: ClientThreadSetIsReadRequest): """Mark all messages in thread as read or unread. @@ -273,3 +273,4 @@ def set_is_read(self, request: ClientThreadSetIsReadRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/cloud_storage_group.py b/sdk/AsposeEmailCloudSdk/api/cloud_storage_group.py index 9cde578..4fcbebb 100644 --- a/sdk/AsposeEmailCloudSdk/api/cloud_storage_group.py +++ b/sdk/AsposeEmailCloudSdk/api/cloud_storage_group.py @@ -1,4 +1,3 @@ - # coding: utf-8 # ---------------------------------------------------------------------------- # @@ -28,37 +27,33 @@ from __future__ import absolute_import from AsposeEmailCloudSdk.api import * + class CloudStorageGroup(object): """ Cloud file storage operations. """ def __init__(self, api_client): - self._file = FileApi(api_client) - self._folder = FolderApi(api_client) - self._storage = StorageApi(api_client) - - + @property def file(self) -> FileApi: """ File operations controller """ return self._file - + @property def folder(self) -> FolderApi: """ Folder operations controller """ return self._folder - + @property def storage(self) -> StorageApi: """ Storage operations controller """ return self._storage - diff --git a/sdk/AsposeEmailCloudSdk/api/contact_api.py b/sdk/AsposeEmailCloudSdk/api/contact_api.py index eed2a5e..2b6e151 100644 --- a/sdk/AsposeEmailCloudSdk/api/contact_api.py +++ b/sdk/AsposeEmailCloudSdk/api/contact_api.py @@ -38,7 +38,7 @@ class ContactApi(ApiBase): def __init__(self, api_client): super(ContactApi, self).__init__(api_client) - + def as_file(self, request: ContactAsFileRequest) -> str: """Converts contact model to specified format and returns as file @@ -67,7 +67,7 @@ def as_file(self, request: ContactAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def as_mapi(self, contact_dto: ContactDto) -> MapiContactDto: """Converts ContactDto to MapiContactDto. @@ -96,7 +96,7 @@ def as_mapi(self, contact_dto: ContactDto) -> MapiContactDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiContactDto') - + def convert(self, request: ContactConvertRequest) -> str: """Converts contact document to specified format and returns as file @@ -154,7 +154,7 @@ def convert(self, request: ContactConvertRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: ContactFromFileRequest) -> ContactDto: """Converts contact document to a model representation @@ -203,7 +203,7 @@ def from_file(self, request: ContactFromFileRequest) -> ContactDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'ContactDto') - + def get(self, request: ContactGetRequest) -> ContactDto: """Get contact document from storage. @@ -268,7 +268,7 @@ def get(self, request: ContactGetRequest) -> ContactDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'ContactDto') - + def get_as_file(self, request: ContactGetAsFileRequest) -> str: """Converts contact document from storage to specified format and returns as file @@ -342,7 +342,7 @@ def get_as_file(self, request: ContactGetAsFileRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'file') - + def get_list(self, request: ContactGetListRequest) -> ContactStorageList: """Get contact list from storage folder. @@ -410,7 +410,7 @@ def get_list(self, request: ContactGetListRequest) -> ContactStorageList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'ContactStorageList') - + def save(self, request: ContactSaveRequest): """Save contact to storage. @@ -439,3 +439,4 @@ def save(self, request: ContactSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/disposable_email_api.py b/sdk/AsposeEmailCloudSdk/api/disposable_email_api.py index ec509b2..a9d2a9a 100644 --- a/sdk/AsposeEmailCloudSdk/api/disposable_email_api.py +++ b/sdk/AsposeEmailCloudSdk/api/disposable_email_api.py @@ -38,7 +38,7 @@ class DisposableEmailApi(ApiBase): def __init__(self, api_client): super(DisposableEmailApi, self).__init__(api_client) - + def is_disposable(self, request: DisposableEmailIsDisposableRequest) -> ValueTOfBoolean: """Check email address is disposable @@ -82,3 +82,4 @@ def is_disposable(self, request: DisposableEmailIsDisposableRequest) -> ValueTOf collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'ValueTOfBoolean') + diff --git a/sdk/AsposeEmailCloudSdk/api/email_api.py b/sdk/AsposeEmailCloudSdk/api/email_api.py index 0071ea5..fabb198 100644 --- a/sdk/AsposeEmailCloudSdk/api/email_api.py +++ b/sdk/AsposeEmailCloudSdk/api/email_api.py @@ -38,7 +38,7 @@ class EmailApi(ApiBase): def __init__(self, api_client): super(EmailApi, self).__init__(api_client) - + def as_file(self, request: EmailAsFileRequest) -> str: """Converts Email model to specified format and returns as file. @@ -67,7 +67,7 @@ def as_file(self, request: EmailAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def as_mapi(self, email_dto: EmailDto) -> MapiMessageDto: """Converts EmailDto to MapiMessageDto. @@ -96,7 +96,7 @@ def as_mapi(self, email_dto: EmailDto) -> MapiMessageDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiMessageDto') - + def convert(self, request: EmailConvertRequest) -> str: """Converts email document to specified format and returns as file @@ -154,7 +154,7 @@ def convert(self, request: EmailConvertRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: EmailFromFileRequest) -> EmailDto: """Converts email document to a model representation @@ -203,7 +203,7 @@ def from_file(self, request: EmailFromFileRequest) -> EmailDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'EmailDto') - + def get(self, request: EmailGetRequest) -> EmailDto: """Get email document from storage. @@ -268,7 +268,7 @@ def get(self, request: EmailGetRequest) -> EmailDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailDto') - + def get_as_file(self, request: EmailGetAsFileRequest) -> str: """Converts email document from storage to specified format and returns as file @@ -333,7 +333,7 @@ def get_as_file(self, request: EmailGetAsFileRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'file') - + def get_list(self, request: EmailGetListRequest) -> EmailStorageList: """Get email list from storage folder. @@ -401,7 +401,7 @@ def get_list(self, request: EmailGetListRequest) -> EmailStorageList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailStorageList') - + def save(self, request: EmailSaveRequest): """Save email document to storage. @@ -430,3 +430,4 @@ def save(self, request: EmailSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/email_cloud.py b/sdk/AsposeEmailCloudSdk/api/email_cloud.py index ca79165..767ce45 100644 --- a/sdk/AsposeEmailCloudSdk/api/email_cloud.py +++ b/sdk/AsposeEmailCloudSdk/api/email_cloud.py @@ -29,6 +29,7 @@ from AsposeEmailCloudSdk import Configuration, ApiClient from AsposeEmailCloudSdk.api import * + class EmailCloud(object): """ Aspose.Email Cloud API. @@ -38,7 +39,7 @@ def __init__(self, app_key=None, app_sid=None, base_url=None, api_version=None, debug=False): """ Initializes a new instance of the EmailCloud class. - + :param app_key: The app key. :type app_key: str :param app_sid: The app sid. diff --git a/sdk/AsposeEmailCloudSdk/api/email_config_api.py b/sdk/AsposeEmailCloudSdk/api/email_config_api.py index 8264b50..a8e1266 100644 --- a/sdk/AsposeEmailCloudSdk/api/email_config_api.py +++ b/sdk/AsposeEmailCloudSdk/api/email_config_api.py @@ -38,7 +38,7 @@ class EmailConfigApi(ApiBase): def __init__(self, api_client): super(EmailConfigApi, self).__init__(api_client) - + def discover(self, request: EmailConfigDiscoverRequest) -> EmailAccountConfigList: """Discover email accounts by email address. Does not validate discovered accounts. @@ -88,7 +88,7 @@ def discover(self, request: EmailConfigDiscoverRequest) -> EmailAccountConfigLis collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'EmailAccountConfigList') - + def discover_oauth(self, request: EmailConfigDiscoverOauthRequest) -> EmailAccountConfigList: """Discover email accounts by email address. Validates discovered accounts using OAuth 2.0. @@ -117,7 +117,7 @@ def discover_oauth(self, request: EmailConfigDiscoverOauthRequest) -> EmailAccou http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'EmailAccountConfigList') - + def discover_password(self, request: EmailConfigDiscoverPasswordRequest) -> EmailAccountConfigList: """Discover email accounts by email address. Validates discovered accounts using login and password. @@ -146,3 +146,4 @@ def discover_password(self, request: EmailConfigDiscoverPasswordRequest) -> Emai http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'EmailAccountConfigList') + diff --git a/sdk/AsposeEmailCloudSdk/api/file_api.py b/sdk/AsposeEmailCloudSdk/api/file_api.py index 7157871..cdcc6ee 100644 --- a/sdk/AsposeEmailCloudSdk/api/file_api.py +++ b/sdk/AsposeEmailCloudSdk/api/file_api.py @@ -38,7 +38,7 @@ class FileApi(ApiBase): def __init__(self, api_client): super(FileApi, self).__init__(api_client) - + def copy_file(self, request: CopyFileRequest): """Copy file @@ -105,7 +105,7 @@ def copy_file(self, request: CopyFileRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def delete_file(self, request: DeleteFileRequest): """Delete file @@ -157,7 +157,7 @@ def delete_file(self, request: DeleteFileRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'DELETE', None) - + def download_file(self, request: DownloadFileRequest) -> str: """Download file @@ -209,7 +209,7 @@ def download_file(self, request: DownloadFileRequest) -> str: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'file') - + def move_file(self, request: MoveFileRequest): """Move file @@ -276,7 +276,7 @@ def move_file(self, request: MoveFileRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def upload_file(self, request: UploadFileRequest) -> FilesUploadResult: """Upload file @@ -327,3 +327,4 @@ def upload_file(self, request: UploadFileRequest) -> FilesUploadResult: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'FilesUploadResult') + diff --git a/sdk/AsposeEmailCloudSdk/api/folder_api.py b/sdk/AsposeEmailCloudSdk/api/folder_api.py index bb53fd9..5c0bb7e 100644 --- a/sdk/AsposeEmailCloudSdk/api/folder_api.py +++ b/sdk/AsposeEmailCloudSdk/api/folder_api.py @@ -38,7 +38,7 @@ class FolderApi(ApiBase): def __init__(self, api_client): super(FolderApi, self).__init__(api_client) - + def copy_folder(self, request: CopyFolderRequest): """Copy folder @@ -99,7 +99,7 @@ def copy_folder(self, request: CopyFolderRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def create_folder(self, request: CreateFolderRequest): """Create the folder @@ -145,7 +145,7 @@ def create_folder(self, request: CreateFolderRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', None) - + def delete_folder(self, request: DeleteFolderRequest): """Delete folder @@ -197,7 +197,7 @@ def delete_folder(self, request: DeleteFolderRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'DELETE', None) - + def get_files_list(self, request: GetFilesListRequest) -> FilesList: """Get all files and folders within a folder @@ -243,7 +243,7 @@ def get_files_list(self, request: GetFilesListRequest) -> FilesList: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'FilesList') - + def move_folder(self, request: MoveFolderRequest): """Move folder @@ -304,3 +304,4 @@ def move_folder(self, request: MoveFolderRequest): collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/mapi_calendar_api.py b/sdk/AsposeEmailCloudSdk/api/mapi_calendar_api.py index 6577a65..1c87bfd 100644 --- a/sdk/AsposeEmailCloudSdk/api/mapi_calendar_api.py +++ b/sdk/AsposeEmailCloudSdk/api/mapi_calendar_api.py @@ -38,7 +38,7 @@ class MapiCalendarApi(ApiBase): def __init__(self, api_client): super(MapiCalendarApi, self).__init__(api_client) - + def as_calendar_dto(self, mapi_calendar_dto: MapiCalendarDto) -> CalendarDto: """Converts MAPI calendar model to CalendarDto model. @@ -67,7 +67,7 @@ def as_calendar_dto(self, mapi_calendar_dto: MapiCalendarDto) -> CalendarDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'CalendarDto') - + def as_file(self, request: MapiCalendarAsFileRequest) -> str: """Converts MAPI calendar model to specified format and returns as file. @@ -96,7 +96,7 @@ def as_file(self, request: MapiCalendarAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: MapiCalendarFromFileRequest) -> MapiCalendarDto: """Converts calendar file to a MAPI model representation. @@ -136,7 +136,7 @@ def from_file(self, request: MapiCalendarFromFileRequest) -> MapiCalendarDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiCalendarDto') - + def get(self, request: MapiCalendarGetRequest) -> MapiCalendarDto: """Get MAPI calendar document. @@ -192,7 +192,7 @@ def get(self, request: MapiCalendarGetRequest) -> MapiCalendarDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MapiCalendarDto') - + def save(self, request: MapiCalendarSaveRequest): """Save MAPI Calendar to storage. @@ -221,3 +221,4 @@ def save(self, request: MapiCalendarSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/mapi_contact_api.py b/sdk/AsposeEmailCloudSdk/api/mapi_contact_api.py index 9109831..508227f 100644 --- a/sdk/AsposeEmailCloudSdk/api/mapi_contact_api.py +++ b/sdk/AsposeEmailCloudSdk/api/mapi_contact_api.py @@ -38,7 +38,7 @@ class MapiContactApi(ApiBase): def __init__(self, api_client): super(MapiContactApi, self).__init__(api_client) - + def as_contact_dto(self, mapi_contact_dto: MapiContactDto) -> ContactDto: """Converts MAPI contact model to ContactDto model. @@ -67,7 +67,7 @@ def as_contact_dto(self, mapi_contact_dto: MapiContactDto) -> ContactDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'ContactDto') - + def as_file(self, request: MapiContactAsFileRequest) -> str: """Converts MAPI contact model to specified format and returns as file. @@ -96,7 +96,7 @@ def as_file(self, request: MapiContactAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: MapiContactFromFileRequest) -> MapiContactDto: """Converts contact file to a MAPI model representation. @@ -145,7 +145,7 @@ def from_file(self, request: MapiContactFromFileRequest) -> MapiContactDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiContactDto') - + def get(self, request: MapiContactGetRequest) -> MapiContactDto: """Get MAPI contact document. @@ -210,7 +210,7 @@ def get(self, request: MapiContactGetRequest) -> MapiContactDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MapiContactDto') - + def save(self, request: MapiContactSaveRequest): """Save MAPI Contact to storage. @@ -239,3 +239,4 @@ def save(self, request: MapiContactSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/mapi_group.py b/sdk/AsposeEmailCloudSdk/api/mapi_group.py index 312ac11..eb92bc3 100644 --- a/sdk/AsposeEmailCloudSdk/api/mapi_group.py +++ b/sdk/AsposeEmailCloudSdk/api/mapi_group.py @@ -1,4 +1,3 @@ - # coding: utf-8 # ---------------------------------------------------------------------------- # @@ -28,37 +27,33 @@ from __future__ import absolute_import from AsposeEmailCloudSdk.api import * + class MapiGroup(object): """ MAPI operations. """ def __init__(self, api_client): - self._calendar = MapiCalendarApi(api_client) - self._contact = MapiContactApi(api_client) - self._message = MapiMessageApi(api_client) - - + @property def calendar(self) -> MapiCalendarApi: """ MAPI calendar operations. """ return self._calendar - + @property def contact(self) -> MapiContactApi: """ MAPI contact operations """ return self._contact - + @property def message(self) -> MapiMessageApi: """ MAPI message operations """ return self._message - diff --git a/sdk/AsposeEmailCloudSdk/api/mapi_message_api.py b/sdk/AsposeEmailCloudSdk/api/mapi_message_api.py index a37a04d..402461e 100644 --- a/sdk/AsposeEmailCloudSdk/api/mapi_message_api.py +++ b/sdk/AsposeEmailCloudSdk/api/mapi_message_api.py @@ -38,7 +38,7 @@ class MapiMessageApi(ApiBase): def __init__(self, api_client): super(MapiMessageApi, self).__init__(api_client) - + def as_email_dto(self, mapi_message: MapiMessageDto) -> EmailDto: """Converts MAPI message model to EmailDto model @@ -67,7 +67,7 @@ def as_email_dto(self, mapi_message: MapiMessageDto) -> EmailDto: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'EmailDto') - + def as_file(self, request: MapiMessageAsFileRequest) -> str: """Converts MAPI message model to specified format and returns as file. @@ -96,7 +96,7 @@ def as_file(self, request: MapiMessageAsFileRequest) -> str: http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', 'file') - + def from_file(self, request: MapiMessageFromFileRequest) -> MapiMessageDto: """Converts email file to a MAPI model representation @@ -145,7 +145,7 @@ def from_file(self, request: MapiMessageFromFileRequest) -> MapiMessageDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'PUT', 'MapiMessageDto') - + def get(self, request: MapiMessageGetRequest) -> MapiMessageDto: """Get MAPI message document. @@ -210,7 +210,7 @@ def get(self, request: MapiMessageGetRequest) -> MapiMessageDto: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'MapiMessageDto') - + def save(self, request: MapiMessageSaveRequest): """Save MAPI message to storage. @@ -239,3 +239,4 @@ def save(self, request: MapiMessageSaveRequest): http_request_object = HttpRequest(path, None, None, header_params, None, body_params, None, None, auth_settings) return self._make_request(http_request_object, 'PUT', None) + diff --git a/sdk/AsposeEmailCloudSdk/api/storage_api.py b/sdk/AsposeEmailCloudSdk/api/storage_api.py index aa230b1..fba6737 100644 --- a/sdk/AsposeEmailCloudSdk/api/storage_api.py +++ b/sdk/AsposeEmailCloudSdk/api/storage_api.py @@ -38,7 +38,7 @@ class StorageApi(ApiBase): def __init__(self, api_client): super(StorageApi, self).__init__(api_client) - + def get_disc_usage(self, request: GetDiscUsageRequest) -> DiscUsage: """Get disc usage @@ -79,7 +79,7 @@ def get_disc_usage(self, request: GetDiscUsageRequest) -> DiscUsage: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'DiscUsage') - + def get_file_versions(self, request: GetFileVersionsRequest) -> FileVersions: """Get file versions @@ -125,7 +125,7 @@ def get_file_versions(self, request: GetFileVersionsRequest) -> FileVersions: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'FileVersions') - + def object_exists(self, request: ObjectExistsRequest) -> ObjectExist: """Check if file or folder exists @@ -177,7 +177,7 @@ def object_exists(self, request: ObjectExistsRequest) -> ObjectExist: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'ObjectExist') - + def exists(self, request: StorageExistsRequest) -> StorageExist: """Check if storage exists @@ -217,3 +217,4 @@ def exists(self, request: StorageExistsRequest) -> StorageExist: collection_formats, auth_settings) return self._make_request(http_request_object, 'GET', 'StorageExist') + diff --git a/sdk/docs/AiBcrApi.md b/sdk/docs/AiBcrApi.md index 9bb3801..ee5cc8e 100644 --- a/sdk/docs/AiBcrApi.md +++ b/sdk/docs/AiBcrApi.md @@ -1,53 +1,229 @@ -# AsposeEmailCloudSdk.AiBcrApi +# AsposeEmailCloudSdk.AiBcrApi (EmailCloud.ai.bcr) + +AI Business card recognition operations. - -# parse +## parse + +Description: Parse images to vCard document models + +Returns: List of vCards + +Method call example: +```python +result = api.ai.bcr.parse(request) +``` + +### Parameter: request + +Description: parse method request. + +See parameter model documentation at [AiBcrParseRequest](AiBcrParseRequest.md). +
+ Parameter initialization example: + ```python -parse(self, request: AiBcrParseRequest) +request = models.AiBcrParseRequest( + file='/path/to/image.png', + countries='us', + languages='en', + is_single=True) ``` -Parse images to vCard document models +
-### Return type +### Result -ContactList +Description: List of vCards + +Return type: [**ContactList**](ContactList.md) + +
+ Result example -### request Parameter ```python -AiBcrParseRequest( - file, - countries, - languages, - is_single) +result = models.ContactList( + value=[ + models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])]) ``` +
+ +### Complete example -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **str** | File to parse | - **countries** | **str** | Comma-separated codes of countries. | [optional] [default to ] - **languages** | **str** | Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. | [optional] [default to ] - **is_single** | **bool** | Determines that image contains single VCard or more. | [optional] [default to true] +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiBcrParseRequest( + file='/path/to/image.png', + countries='us', + languages='en', + is_single=True) + +// Call method: +result = api.ai.bcr.parse(request) + +// Result example: +result = models.ContactList( + value=[ + models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# parse_storage +## parse_storage + +Description: Parse images from storage to vCard files + +Returns: List of vCard files located on storage +Method call example: ```python -parse_storage(self, AiBcrParseStorageRequest request) +result = api.ai.bcr.parse_storage(request) ``` -Parse images from storage to vCard files +### Parameter: request -### Return type +Description: Request with images located on storage -[**StorageFileLocationList**](StorageFileLocationList.md) +See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.AiBcrParseStorageRequest( + out_folder=models.StorageFolderLocation( + storage='First Storage', + folder_path='VCard/files/produced/by/parser/will/be/placed/here'), + images=[ + models.AiBcrImageStorageFile( + file=models.StorageFileLocation( + file_name='VCardScanImage.jpg', + storage='First Storage', + folder_path='image/location/on/storage'), + is_single=True)]) +``` -See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) +
+ +### Result + +Description: List of vCard files located on storage + +Return type: [**StorageFileLocationList**](StorageFileLocationList.md) + +
+ Result example + +```python +result = models.StorageFileLocationList( + value=[ + models.StorageFileLocation( + file_name='fileOnStorage.txt', + storage='First Storage', + folder_path='file/location/folder/on/storage')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiBcrParseStorageRequest( + out_folder=models.StorageFolderLocation( + storage='First Storage', + folder_path='VCard/files/produced/by/parser/will/be/placed/here'), + images=[ + models.AiBcrImageStorageFile( + file=models.StorageFileLocation( + file_name='VCardScanImage.jpg', + storage='First Storage', + folder_path='image/location/on/storage'), + is_single=True)]) + +// Call method: +result = api.ai.bcr.parse_storage(request) + +// Result example: +result = models.StorageFileLocationList( + value=[ + models.StorageFileLocation( + file_name='fileOnStorage.txt', + storage='First Storage', + folder_path='file/location/folder/on/storage')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiBcrApi_list.md b/sdk/docs/AiBcrApi_list.md index 26db5a6..3d42de2 100644 --- a/sdk/docs/AiBcrApi_list.md +++ b/sdk/docs/AiBcrApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for AiBcrApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/AiBcrImage.md b/sdk/docs/AiBcrImage.md index 1b391f2..4fe003d 100644 --- a/sdk/docs/AiBcrImage.md +++ b/sdk/docs/AiBcrImage.md @@ -1,11 +1,14 @@ # AsposeEmailCloudSdk.models.AiBcrImage + +Image for recognition + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_single** | **bool** | Determines that image contains single VCard or more. | +**is_single** |**bool** |Determines that image contains single VCard or more. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiBcrImageStorageFile.md b/sdk/docs/AiBcrImageStorageFile.md index 2093bd2..8c9f88e 100644 --- a/sdk/docs/AiBcrImageStorageFile.md +++ b/sdk/docs/AiBcrImageStorageFile.md @@ -1,11 +1,25 @@ # AsposeEmailCloudSdk.models.AiBcrImageStorageFile + +Image from storage for recognition + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location | +**file** |[**StorageFileLocation**](StorageFileLocation.md) |Image location | - Parent class: [AiBcrImage](AiBcrImage.md) +Parent class: [AiBcrImage](AiBcrImage.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_bcr_image_storage_file = models.AiBcrImageStorageFile( + file=models.StorageFileLocation( + file_name='VCardScanImage.jpg', + storage='First Storage', + folder_path='image/location/on/storage'), + is_single=True) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiBcrOptions.md b/sdk/docs/AiBcrOptions.md index bce768f..2315f0a 100644 --- a/sdk/docs/AiBcrOptions.md +++ b/sdk/docs/AiBcrOptions.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.AiBcrOptions + +Recognition options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**languages** | **str** | Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. | [optional] -**countries** | **str** | Comma-separated codes of countries. | [optional] +**languages** |**str** |Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. |[optional] +**countries** |**str** |Comma-separated codes of countries. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiBcrParseRequest.md b/sdk/docs/AiBcrParseRequest.md new file mode 100644 index 0000000..1ed6e24 --- /dev/null +++ b/sdk/docs/AiBcrParseRequest.md @@ -0,0 +1,21 @@ +# AiBcrParseRequest + +Request model for AiBcrApi.parse + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file** |**str** |File to parse | +**countries** |**str** |Comma-separated codes of countries. |[optional] [default to ] +**languages** |**str** |Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. |[optional] [default to ] +**is_single** |**bool** |Determines that image contains single VCard or more. |[optional] [default to true] + +## Example +```python +request = models.AiBcrParseRequest( + file='/path/to/image.png', + countries='us', + languages='en', + is_single=True) +``` diff --git a/sdk/docs/AiBcrParseStorageRequest.md b/sdk/docs/AiBcrParseStorageRequest.md index c0ae169..3ec8ff1 100644 --- a/sdk/docs/AiBcrParseStorageRequest.md +++ b/sdk/docs/AiBcrParseStorageRequest.md @@ -1,13 +1,31 @@ # AsposeEmailCloudSdk.models.AiBcrParseStorageRequest + +Parse business card images from Storage request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**out_folder** | [**StorageFolderLocation**](StorageFolderLocation.md) | Parse output folder location on storage | -**images** | [**list[AiBcrImageStorageFile]**](AiBcrImageStorageFile.md) | Images to parse. | -**options** | [**AiBcrOptions**](AiBcrOptions.md) | Recognition options. | [optional] +**out_folder** |[**StorageFolderLocation**](StorageFolderLocation.md) |Parse output folder location on storage | +**images** |[**list[AiBcrImageStorageFile]**](AiBcrImageStorageFile.md) |Images to parse. | +**options** |[**AiBcrOptions**](AiBcrOptions.md) |Recognition options. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_bcr_parse_storage_request = models.AiBcrParseStorageRequest( + out_folder=models.StorageFolderLocation( + storage='First Storage', + folder_path='VCard/files/produced/by/parser/will/be/placed/here'), + images=[ + models.AiBcrImageStorageFile( + file=models.StorageFileLocation( + file_name='VCardScanImage.jpg', + storage='First Storage', + folder_path='image/location/on/storage'), + is_single=True)]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameApi.md b/sdk/docs/AiNameApi.md index 1c12a1b..2b358e7 100644 --- a/sdk/docs/AiNameApi.md +++ b/sdk/docs/AiNameApi.md @@ -1,328 +1,983 @@ -# AsposeEmailCloudSdk.AiNameApi +# AsposeEmailCloudSdk.AiNameApi (EmailCloud.ai.name) + +AI Name operations. - -# complete +## complete + +Description: The call proposes k most probable names for given starting characters. + +Returns: List of name variations. + +Method call example: +```python +result = api.ai.name.complete(request) +``` +### Parameter: request + +Description: complete method request. + +See parameter model documentation at [AiNameCompleteRequest](AiNameCompleteRequest.md). + +
+ Parameter initialization example: + ```python -complete(self, request: AiNameCompleteRequest) +request = models.AiNameCompleteRequest( + name='Dav') ``` -The call proposes k most probable names for given starting characters. +
+ +### Result + +Description: List of name variations. + +Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) -### Return type +
+ Result example -AiNameWeightedVariants +```python +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) +``` +
+ +### Complete example + +
+ Method call example: -### request Parameter ```python -AiNameCompleteRequest( - name, - language, - location, - encoding, - script, - style) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameCompleteRequest( + name='Dav') + +// Call method: +result = api.ai.name.complete(request) + +// Result example: +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to complete. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# expand +## expand + +Description: Expands a person's name into a list of possible alternatives using options for expanding instructions. + +Returns: List of name variations. + +Method call example: +```python +result = api.ai.name.expand(request) +``` + +### Parameter: request + +Description: expand method request. + +See parameter model documentation at [AiNameExpandRequest](AiNameExpandRequest.md). +
+ Parameter initialization example: + ```python -expand(self, request: AiNameExpandRequest) +request = models.AiNameExpandRequest( + name='John Cane') ``` -Expands a person's name into a list of possible alternatives using options for expanding instructions. +
-### Return type +### Result -AiNameWeightedVariants +Description: List of name variations. + +Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) + +
+ Result example + +```python +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) +``` +
+ +### Complete example + +
+ Method call example: -### request Parameter ```python -AiNameExpandRequest( - name, - language, - location, - encoding, - script, - style) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameExpandRequest( + name='John Cane') + +// Call method: +result = api.ai.name.expand(request) + +// Result example: +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to expand. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# expand_parsed +## expand_parsed + +Description: Expands a person's parsed name into a list of possible alternatives using options for expanding instructions. + +Returns: List of name variations. + +Method call example: +```python +result = api.ai.name.expand_parsed(request) +``` +### Parameter: request + +Description: Parsed name with options. + +See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) + +
+ Parameter initialization example: + ```python -expand_parsed(self, AiNameParsedRequest request) +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) ``` -Expands a person's parsed name into a list of possible alternatives using options for expanding instructions. +
-### Return type +### Result -[**AiNameWeightedVariants**](AiNameWeightedVariants.md) +Description: List of name variations. -### request Parameter +Return type: [**AiNameWeightedVariants**](AiNameWeightedVariants.md) -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) +
+ Result example + +```python +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) + +// Call method: +result = api.ai.name.expand_parsed(request) + +// Result example: +result = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# format +## format + +Description: Formats a person's name in correct case and name order using options for formatting instructions. + +Returns: Formatted name. + +Method call example: +```python +result = api.ai.name.format(request) +``` + +### Parameter: request + +Description: format method request. +See parameter model documentation at [AiNameFormatRequest](AiNameFormatRequest.md). + +
+ Parameter initialization example: + ```python -format(self, request: AiNameFormatRequest) +request = models.AiNameFormatRequest( + name='Mr. John Michael Cane', + format='%t%L%f%m') ``` -Formats a person's name in correct case and name order using options for formatting instructions. +
+ +### Result + +Description: Formatted name. -### Return type +Return type: [**AiNameFormatted**](AiNameFormatted.md) -AiNameFormatted +
+ Result example -### request Parameter ```python -AiNameFormatRequest( - name, - language, - location, - encoding, - script, - format, - style) +result = models.AiNameFormatted( + name='Mr. Cane J. M.', + comments='format: %t%L%f%m; source: parsed format') ``` +
-Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to format. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **format** | **str** | 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 ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameFormatRequest( + name='Mr. John Michael Cane', + format='%t%L%f%m') + +// Call method: +result = api.ai.name.format(request) + +// Result example: +result = models.AiNameFormatted( + name='Mr. Cane J. M.', + comments='format: %t%L%f%m; source: parsed format') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# format_parsed +## format_parsed + +Description: Formats a person's parsed name in correct case and name order using options for formatting instructions. + +Returns: Formatted name. + +Method call example: +```python +result = api.ai.name.format_parsed(request) +``` + +### Parameter: request + +Description: Parsed name with options. +See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) + +
+ Parameter initialization example: + ```python -format_parsed(self, AiNameParsedRequest request) +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) ``` -Formats a person's parsed name in correct case and name order using options for formatting instructions. +
-### Return type +### Result -[**AiNameFormatted**](AiNameFormatted.md) +Description: Formatted name. -### request Parameter +Return type: [**AiNameFormatted**](AiNameFormatted.md) -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) +
+ Result example + +```python +result = models.AiNameFormatted( + name='Mr. Cane J. M.', + comments='format: %t%L%f%m; source: parsed format') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) + +// Call method: +result = api.ai.name.format_parsed(request) + +// Result example: +result = models.AiNameFormatted( + name='Mr. Cane J. M.', + comments='format: %t%L%f%m; source: parsed format') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# genderize +## genderize +Description: Detect person's gender from name string. + +Returns: Hypotheses about person's gender. + +Method call example: ```python -genderize(self, request: AiNameGenderizeRequest) +result = api.ai.name.genderize(request) ``` -Detect person's gender from name string. +### Parameter: request -### Return type +Description: genderize method request. -AiNameGenderHypothesisList +See parameter model documentation at [AiNameGenderizeRequest](AiNameGenderizeRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -AiNameGenderizeRequest( - name, - language, - location, - encoding, - script, - style) +request = models.AiNameGenderizeRequest( + name='John Cane') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to genderize. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +
+ +### Result + +Description: Hypotheses about person's gender. + +Return type: [**AiNameGenderHypothesisList**](AiNameGenderHypothesisList.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameGenderizeRequest( + name='John Cane') + +// Call method: +result = api.ai.name.genderize(request) + +// Result example: +result = +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# genderize_parsed +## genderize_parsed + +Description: Detect person's gender from parsed name. + +Returns: Hypotheses about person's gender. + +Method call example: +```python +result = api.ai.name.genderize_parsed(request) +``` + +### Parameter: request + +Description: Gender detection request data. + +See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) +
+ Parameter initialization example: + ```python -genderize_parsed(self, AiNameParsedRequest request) +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) ``` -Detect person's gender from parsed name. +
-### Return type +### Result -[**AiNameGenderHypothesisList**](AiNameGenderHypothesisList.md) +Description: Hypotheses about person's gender. -### request Parameter +Return type: [**AiNameGenderHypothesisList**](AiNameGenderHypothesisList.md) -See parameter model documentation at [AiNameParsedRequest](AiNameParsedRequest.md) +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) + +// Call method: +result = api.ai.name.genderize_parsed(request) + +// Result example: +result = +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# match +## match + +Description: Compare people's names. Uses options for comparing instructions. + +Returns: Match result. + +Method call example: +```python +result = api.ai.name.match(request) +``` + +### Parameter: request + +Description: match method request. + +See parameter model documentation at [AiNameMatchRequest](AiNameMatchRequest.md). +
+ Parameter initialization example: + ```python -match(self, request: AiNameMatchRequest) +request = models.AiNameMatchRequest( + name='John Michael Cane', + other_name='Cane J.') ``` -Compare people's names. Uses options for comparing instructions. +
-### Return type +### Result -AiNameMatchResult +Description: Match result. + +Return type: [**AiNameMatchResult**](AiNameMatchResult.md) + +
+ Result example + +```python +result = models.AiNameMatchResult( + similarity=0.6, + mismatches=[ + models.AiNameMismatch( + category='Gender', + explanation='no_match')]) +``` +
+ +### Complete example + +
+ Method call example: -### request Parameter ```python -AiNameMatchRequest( - name, - other_name, - language, - location, - encoding, - script, - style) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameMatchRequest( + name='John Michael Cane', + other_name='Cane J.') + +// Call method: +result = api.ai.name.match(request) + +// Result example: +result = models.AiNameMatchResult( + similarity=0.6, + mismatches=[ + models.AiNameMismatch( + category='Gender', + explanation='no_match')]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to match. | - **other_name** | **str** | Another name to match. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# match_parsed +## match_parsed + +Description: Compare people's parsed names and attributes. Uses options for comparing instructions. + +Returns: Match result. +Method call example: ```python -match_parsed(self, AiNameMatchParsedRequest request) +result = api.ai.name.match_parsed(request) ``` -Compare people's parsed names and attributes. Uses options for comparing instructions. +### Parameter: request -### Return type +Description: Parsed names to match. -[**AiNameMatchResult**](AiNameMatchResult.md) +See parameter model documentation at [AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.AiNameMatchParsedRequest( + other_parsed_name=[ + models.AiNameComponent( + value='J', + category='FirstInitial', + score=1), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=3), + models.AiNameComponent( + value='%f%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)], + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) +``` -See parameter model documentation at [AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) +
+ +### Result + +Description: Match result. + +Return type: [**AiNameMatchResult**](AiNameMatchResult.md) + +
+ Result example + +```python +result = models.AiNameMatchResult( + similarity=0.6, + mismatches=[ + models.AiNameMismatch( + category='Gender', + explanation='no_match')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameMatchParsedRequest( + other_parsed_name=[ + models.AiNameComponent( + value='J', + category='FirstInitial', + score=1), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=3), + models.AiNameComponent( + value='%f%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)], + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) + +// Call method: +result = api.ai.name.match_parsed(request) + +// Result example: +result = models.AiNameMatchResult( + similarity=0.6, + mismatches=[ + models.AiNameMismatch( + category='Gender', + explanation='no_match')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# parse +## parse + +Description: Parse name to components. + +Returns: List of name components. + +Method call example: +```python +result = api.ai.name.parse(request) +``` + +### Parameter: request + +Description: parse method request. +See parameter model documentation at [AiNameParseRequest](AiNameParseRequest.md). + +
+ Parameter initialization example: + ```python -parse(self, request: AiNameParseRequest) +request = models.AiNameParseRequest( + name='John Cane', + language='eng', + location='USA') ``` -Parse name to components. +
+ +### Result + +Description: List of name components. -### Return type +Return type: [**AiNameComponentList**](AiNameComponentList.md) -AiNameComponentList +
+ Result example -### request Parameter ```python -AiNameParseRequest( - name, - language, - location, - encoding, - script, - style) +result = models.AiNameComponentList( + value=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) ``` +
-Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str** | A name to parse. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameParseRequest( + name='John Cane', + language='eng', + location='USA') + +// Call method: +result = api.ai.name.parse(request) + +// Result example: +result = models.AiNameComponentList( + value=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# parse_email_address +## parse_email_address + +Description: Parse person's name out of an email address. +Returns: Match result. + +Method call example: ```python -parse_email_address(self, request: AiNameParseEmailAddressRequest) +result = api.ai.name.parse_email_address(request) ``` -Parse person's name out of an email address. +### Parameter: request -### Return type +Description: parse_email_address method request. -AiNameExtractedList +See parameter model documentation at [AiNameParseEmailAddressRequest](AiNameParseEmailAddressRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -AiNameParseEmailAddressRequest( - email_address, - language, - location, - encoding, - script, - style) +request = models.AiNameParseEmailAddressRequest( + email_address='john-cane@gmail.com') +``` + +
+ +### Result + +Description: Match result. + +Return type: [**AiNameExtractedList**](AiNameExtractedList.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.AiNameParseEmailAddressRequest( + email_address='john-cane@gmail.com') + +// Call method: +result = api.ai.name.parse_email_address(request) + +// Result example: +result = ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_address** | **str** | Email address to parse. | - **language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). | [optional] [default to ] - **location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. | [optional] [default to ] - **encoding** | **str** | A character encoding name. | [optional] [default to ] - **script** | **str** | A writing system code; starts with the ISO-15924 script name. | [optional] [default to ] - **style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | [optional] [default to 0] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameApi_list.md b/sdk/docs/AiNameApi_list.md index a740780..87b148d 100644 --- a/sdk/docs/AiNameApi_list.md +++ b/sdk/docs/AiNameApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for AiNameApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/AiNameCompleteRequest.md b/sdk/docs/AiNameCompleteRequest.md new file mode 100644 index 0000000..ca479b2 --- /dev/null +++ b/sdk/docs/AiNameCompleteRequest.md @@ -0,0 +1,20 @@ +# AiNameCompleteRequest + +Request model for AiNameApi.complete + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to complete. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameCompleteRequest( + name='Dav') +``` diff --git a/sdk/docs/AiNameComponent.md b/sdk/docs/AiNameComponent.md index ef86a69..9d8e5be 100644 --- a/sdk/docs/AiNameComponent.md +++ b/sdk/docs/AiNameComponent.md @@ -1,14 +1,17 @@ # AsposeEmailCloudSdk.models.AiNameComponent + +Parsed name component + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Component value | [optional] -**category** | **str** | Name component category. Enum, available values: Unknown, Mononym, Score, Format, FirstInitial, FirstName, MiddleInitial, MiddleName, MiddleNickname, MiddleSobriquet, MiddleMaidenName, MiddlePatronym, MiddleMatronym, LastInitial, LastName, LastNobiliaryParticle, LastNominalConjunction, LastPaternalSurname, LastMaternalSurname, PrefixTitle, PostfixGenerationalTitle, PostfixPostnominalLetters, ArabicIsm, ArabicKunya, ArabicNasab, ArabicSlaqab, ArabicNisbah | -**score** | **float** | Score from 0.0 to 1.0 | -**position** | **int** | Component position from 0 | +**value** |**str** |Component value |[optional] +**category** |**str** |Name component category. Enum, available values: Unknown, Mononym, Score, Format, FirstInitial, FirstName, MiddleInitial, MiddleName, MiddleNickname, MiddleSobriquet, MiddleMaidenName, MiddlePatronym, MiddleMatronym, LastInitial, LastName, LastNobiliaryParticle, LastNominalConjunction, LastPaternalSurname, LastMaternalSurname, PrefixTitle, PostfixGenerationalTitle, PostfixPostnominalLetters, ArabicIsm, ArabicKunya, ArabicNasab, ArabicSlaqab, ArabicNisbah | +**score** |**float** |Score from 0.0 to 1.0 | +**position** |**int** |Component position from 0 | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameComponentList.md b/sdk/docs/AiNameComponentList.md index 7bd4050..24638a7 100644 --- a/sdk/docs/AiNameComponentList.md +++ b/sdk/docs/AiNameComponentList.md @@ -1,10 +1,36 @@ # AsposeEmailCloudSdk.models.AiNameComponentList + +List of name components + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) +Parent class: [ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_component_list = models.AiNameComponentList( + value=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameCulturalContext.md b/sdk/docs/AiNameCulturalContext.md index d2d78da..f2de3d0 100644 --- a/sdk/docs/AiNameCulturalContext.md +++ b/sdk/docs/AiNameCulturalContext.md @@ -1,15 +1,18 @@ # AsposeEmailCloudSdk.models.AiNameCulturalContext + +AiName cultural context + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**language** | **str** | An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) | [optional] -**location** | **str** | A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France | [optional] -**script** | **str** | A writing system code; starts with the ISO-15924 script name | [optional] -**encoding** | **str** | A character encoding name | [optional] -**style** | **str** | Name writing style. Enum, available values: Formal, Informal, Legal, Academic | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian) |[optional] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France |[optional] +**script** |**str** |A writing system code; starts with the ISO-15924 script name |[optional] +**encoding** |**str** |A character encoding name |[optional] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameExpandRequest.md b/sdk/docs/AiNameExpandRequest.md new file mode 100644 index 0000000..86e81fd --- /dev/null +++ b/sdk/docs/AiNameExpandRequest.md @@ -0,0 +1,20 @@ +# AiNameExpandRequest + +Request model for AiNameApi.expand + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to expand. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameExpandRequest( + name='John Cane') +``` diff --git a/sdk/docs/AiNameExtracted.md b/sdk/docs/AiNameExtracted.md index a207eee..7276a61 100644 --- a/sdk/docs/AiNameExtracted.md +++ b/sdk/docs/AiNameExtracted.md @@ -1,12 +1,28 @@ # AsposeEmailCloudSdk.models.AiNameExtracted + +Extracted name + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | [**list[AiNameExtractedComponent]**](AiNameExtractedComponent.md) | Extracted name components | [optional] -**score** | **float** | Extracted name score | +**name** |[**list[AiNameExtractedComponent]**](AiNameExtractedComponent.md) |Extracted name components |[optional] +**score** |**float** |Extracted name score | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_extracted = models.AiNameExtracted( + name=[ + models.AiNameExtractedComponent( + category='Surname', + value='Cane'), + models.AiNameExtractedComponent( + category='SomeName', + value='John')], + score=0.5) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameExtractedComponent.md b/sdk/docs/AiNameExtractedComponent.md index 348367d..c56bb2e 100644 --- a/sdk/docs/AiNameExtractedComponent.md +++ b/sdk/docs/AiNameExtractedComponent.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.AiNameExtractedComponent + +Extracted name component + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | **str** | Extracted from email address name component category. Enum, available values: Unknown, GivenName, Surname, SomeName, NoName, Initial | -**value** | **str** | Extracted value | [optional] +**category** |**str** |Extracted from email address name component category. Enum, available values: Unknown, GivenName, Surname, SomeName, NoName, Initial | +**value** |**str** |Extracted value |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameExtractedList.md b/sdk/docs/AiNameExtractedList.md index f28f7ce..e42e75a 100644 --- a/sdk/docs/AiNameExtractedList.md +++ b/sdk/docs/AiNameExtractedList.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.AiNameExtractedList + +Extracted name list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) +Parent class: [ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameFormatRequest.md b/sdk/docs/AiNameFormatRequest.md new file mode 100644 index 0000000..8184b57 --- /dev/null +++ b/sdk/docs/AiNameFormatRequest.md @@ -0,0 +1,22 @@ +# AiNameFormatRequest + +Request model for AiNameApi.format + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to format. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**format** |**str** |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 ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameFormatRequest( + name='Mr. John Michael Cane', + format='%t%L%f%m') +``` diff --git a/sdk/docs/AiNameFormatted.md b/sdk/docs/AiNameFormatted.md index 4b7ee82..687b8c6 100644 --- a/sdk/docs/AiNameFormatted.md +++ b/sdk/docs/AiNameFormatted.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.AiNameFormatted + +Formatted name + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Formatted name value | [optional] -**comments** | **str** | Usually empty; can contain extra message describing some issue occurred during the formatting | [optional] +**name** |**str** |Formatted name value |[optional] +**comments** |**str** |Usually empty; can contain extra message describing some issue occurred during the formatting |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_formatted = models.AiNameFormatted( + name='Mr. Cane J. M.', + comments='format: %t%L%f%m; source: parsed format') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameGenderHypothesis.md b/sdk/docs/AiNameGenderHypothesis.md index 9c64d76..36fcea2 100644 --- a/sdk/docs/AiNameGenderHypothesis.md +++ b/sdk/docs/AiNameGenderHypothesis.md @@ -1,12 +1,21 @@ # AsposeEmailCloudSdk.models.AiNameGenderHypothesis + +Name gender hypothesis + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**gender** | **str** | Recognized name gender. Enum, available values: Male, Female, Unknown | -**score** | **float** | Hypothesis score | +**gender** |**str** |Recognized name gender. Enum, available values: Male, Female, Unknown | +**score** |**float** |Hypothesis score | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_gender_hypothesis = models.AiNameGenderHypothesis( + score=0.8) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameGenderHypothesisList.md b/sdk/docs/AiNameGenderHypothesisList.md index 8870c28..af87482 100644 --- a/sdk/docs/AiNameGenderHypothesisList.md +++ b/sdk/docs/AiNameGenderHypothesisList.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.AiNameGenderHypothesisList + +Hypotheses about person's gender + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) +Parent class: [ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameGenderizeRequest.md b/sdk/docs/AiNameGenderizeRequest.md new file mode 100644 index 0000000..bbbbe12 --- /dev/null +++ b/sdk/docs/AiNameGenderizeRequest.md @@ -0,0 +1,20 @@ +# AiNameGenderizeRequest + +Request model for AiNameApi.genderize + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to genderize. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameGenderizeRequest( + name='John Cane') +``` diff --git a/sdk/docs/AiNameMatchParsedRequest.md b/sdk/docs/AiNameMatchParsedRequest.md index fb2c475..86701f8 100644 --- a/sdk/docs/AiNameMatchParsedRequest.md +++ b/sdk/docs/AiNameMatchParsedRequest.md @@ -1,11 +1,54 @@ # AsposeEmailCloudSdk.models.AiNameMatchParsedRequest + +Two parsed names to match request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**other_parsed_name** | [**list[AiNameComponent]**](AiNameComponent.md) | Other parsed name to match | +**other_parsed_name** |[**list[AiNameComponent]**](AiNameComponent.md) |Other parsed name to match | - Parent class: [AiNameParsedRequest](AiNameParsedRequest.md) +Parent class: [AiNameParsedRequest](AiNameParsedRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_match_parsed_request = models.AiNameMatchParsedRequest( + other_parsed_name=[ + models.AiNameComponent( + value='J', + category='FirstInitial', + score=1), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=3), + models.AiNameComponent( + value='%f%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)], + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameMatchRequest.md b/sdk/docs/AiNameMatchRequest.md new file mode 100644 index 0000000..fad06a8 --- /dev/null +++ b/sdk/docs/AiNameMatchRequest.md @@ -0,0 +1,22 @@ +# AiNameMatchRequest + +Request model for AiNameApi.match + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to match. | +**other_name** |**str** |Another name to match. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameMatchRequest( + name='John Michael Cane', + other_name='Cane J.') +``` diff --git a/sdk/docs/AiNameMatchResult.md b/sdk/docs/AiNameMatchResult.md index 32072a1..80fcf59 100644 --- a/sdk/docs/AiNameMatchResult.md +++ b/sdk/docs/AiNameMatchResult.md @@ -1,12 +1,25 @@ # AsposeEmailCloudSdk.models.AiNameMatchResult + +Two names match result + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**similarity** | **float** | Similarity score | -**mismatches** | [**list[AiNameMismatch]**](AiNameMismatch.md) | Detailed description of mismatches | [optional] +**similarity** |**float** |Similarity score | +**mismatches** |[**list[AiNameMismatch]**](AiNameMismatch.md) |Detailed description of mismatches |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_match_result = models.AiNameMatchResult( + similarity=0.6, + mismatches=[ + models.AiNameMismatch( + category='Gender', + explanation='no_match')]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameMismatch.md b/sdk/docs/AiNameMismatch.md index 5e21bce..fc31c73 100644 --- a/sdk/docs/AiNameMismatch.md +++ b/sdk/docs/AiNameMismatch.md @@ -1,13 +1,23 @@ # AsposeEmailCloudSdk.models.AiNameMismatch + +Names mismatch detailed description + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | **str** | Mismatch type. Enum, available values: Unknown, FirstName, MiddleName, MiddleLastName, MiddleNickname, Gender, Context | -**similarity** | **float** | Similarity score | -**explanation** | **str** | Explanation or mismatch subtype | [optional] +**category** |**str** |Mismatch type. Enum, available values: Unknown, FirstName, MiddleName, MiddleLastName, MiddleNickname, Gender, Context | +**similarity** |**float** |Similarity score | +**explanation** |**str** |Explanation or mismatch subtype |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_mismatch = models.AiNameMismatch( + category='Gender', + explanation='no_match') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameParseEmailAddressRequest.md b/sdk/docs/AiNameParseEmailAddressRequest.md new file mode 100644 index 0000000..4850653 --- /dev/null +++ b/sdk/docs/AiNameParseEmailAddressRequest.md @@ -0,0 +1,20 @@ +# AiNameParseEmailAddressRequest + +Request model for AiNameApi.parse_email_address + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**email_address** |**str** |Email address to parse. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameParseEmailAddressRequest( + email_address='john-cane@gmail.com') +``` diff --git a/sdk/docs/AiNameParseRequest.md b/sdk/docs/AiNameParseRequest.md new file mode 100644 index 0000000..9e66915 --- /dev/null +++ b/sdk/docs/AiNameParseRequest.md @@ -0,0 +1,22 @@ +# AiNameParseRequest + +Request model for AiNameApi.parse + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**name** |**str** |A name to parse. | +**language** |**str** |An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \"it\" or \"ita\" for Italian). |[optional] [default to ] +**location** |**str** |A geographic code such as an ISO-3166 two letter country code, for example \"FR\" for France. |[optional] [default to ] +**encoding** |**str** |A character encoding name. |[optional] [default to ] +**script** |**str** |A writing system code; starts with the ISO-15924 script name. |[optional] [default to ] +**style** |**str** |Name writing style. Enum, available values: Formal, Informal, Legal, Academic |[optional] [default to 0] + +## Example +```python +request = models.AiNameParseRequest( + name='John Cane', + language='eng', + location='USA') +``` diff --git a/sdk/docs/AiNameParsedRequest.md b/sdk/docs/AiNameParsedRequest.md index cd9df85..7753ba5 100644 --- a/sdk/docs/AiNameParsedRequest.md +++ b/sdk/docs/AiNameParsedRequest.md @@ -1,13 +1,38 @@ # AsposeEmailCloudSdk.models.AiNameParsedRequest + +Parsed name request model + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cultural_context** | [**AiNameCulturalContext**](AiNameCulturalContext.md) | AiName parser cultural context | [optional] -**format** | **str** | 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] -**parsed_name** | [**list[AiNameComponent]**](AiNameComponent.md) | Parsed name | +**cultural_context** |[**AiNameCulturalContext**](AiNameCulturalContext.md) |AiName parser cultural context |[optional] +**format** |**str** |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] +**parsed_name** |[**list[AiNameComponent]**](AiNameComponent.md) |Parsed name | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_parsed_request = models.AiNameParsedRequest( + parsed_name=[ + models.AiNameComponent( + value='John', + category='FirstName', + score=0.95), + models.AiNameComponent( + value='Cane', + category='LastName', + score=0.5, + position=5), + models.AiNameComponent( + value='%F%L', + category='Format'), + models.AiNameComponent( + value='0.5', + category='Score', + score=0.5)]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AiNameWeighted.md b/sdk/docs/AiNameWeighted.md index b947371..5c3a1bb 100644 --- a/sdk/docs/AiNameWeighted.md +++ b/sdk/docs/AiNameWeighted.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.AiNameWeighted + +Name with score + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Name | [optional] -**score** | **float** | Score of name | +**name** |**str** |Name |[optional] +**score** |**float** |Score of name | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AiNameWeightedVariants.md b/sdk/docs/AiNameWeightedVariants.md index 753d4c1..5e328b5 100644 --- a/sdk/docs/AiNameWeightedVariants.md +++ b/sdk/docs/AiNameWeightedVariants.md @@ -1,12 +1,27 @@ # AsposeEmailCloudSdk.models.AiNameWeightedVariants + +Name variants + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**names** | [**list[AiNameWeighted]**](AiNameWeighted.md) | List of name variations | [optional] -**comments** | **str** | Usually empty; can contain extra message describing some issue occurred during processing | [optional] +**names** |[**list[AiNameWeighted]**](AiNameWeighted.md) |List of name variations |[optional] +**comments** |**str** |Usually empty; can contain extra message describing some issue occurred during processing |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +ai_name_weighted_variants = models.AiNameWeightedVariants( + names=[ + models.AiNameWeighted( + name='J. Cane', + score=1), + models.AiNameWeighted( + name='Mr. Cane', + score=0.75)]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AlternateView.md b/sdk/docs/AlternateView.md index d43a2f9..0e1cb2d 100644 --- a/sdk/docs/AlternateView.md +++ b/sdk/docs/AlternateView.md @@ -1,12 +1,37 @@ # AsposeEmailCloudSdk.models.AlternateView + +Represents the format to view a message. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base_uri** | **str** | Base URI. | [optional] -**linked_resources** | [**list[LinkedResource]**](LinkedResource.md) | Embedded resources referred to by this alternate view. | [optional] +**base_uri** |**str** |Base URI. |[optional] +**linked_resources** |[**list[LinkedResource]**](LinkedResource.md) |Embedded resources referred to by this alternate view. |[optional] - Parent class: [AttachmentBase](AttachmentBase.md) +Parent class: [AttachmentBase](AttachmentBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +alternate_view = models.AlternateView( + base64_data='', + content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', + content_type=models.ContentType( + char_set='utf-8', + media_type='text/calendar', + name='meeting.ics', + parameters=[ + models.ContentTypeParameter( + name='Method', + value='REQUEST'), + models.ContentTypeParameter( + name='Name', + value='meeting.ics'), + models.ContentTypeParameter( + name='charset', + value='utf-8')])) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/AssociatedPerson.md b/sdk/docs/AssociatedPerson.md index 046dbd8..6015d15 100644 --- a/sdk/docs/AssociatedPerson.md +++ b/sdk/docs/AssociatedPerson.md @@ -1,13 +1,16 @@ # AsposeEmailCloudSdk.models.AssociatedPerson + +Describes associated person. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Associated person's name. | [optional] -**category** | [**EnumWithCustomOfAssociatedPersonCategory**](EnumWithCustomOfAssociatedPersonCategory.md) | Associated person's category. | [optional] -**preferred** | **bool** | Defines whether associated person is preferred. | +**name** |**str** |Associated person's name. |[optional] +**category** |[**EnumWithCustomOfAssociatedPersonCategory**](EnumWithCustomOfAssociatedPersonCategory.md) |Associated person's category. |[optional] +**preferred** |**bool** |Defines whether associated person is preferred. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/Attachment.md b/sdk/docs/Attachment.md index 0f0856c..2434a03 100644 --- a/sdk/docs/Attachment.md +++ b/sdk/docs/Attachment.md @@ -1,15 +1,19 @@ # AsposeEmailCloudSdk.models.Attachment + +Document attachment. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content_disposition** | **str** | Content-Disposition header. Read only. | [optional] -**is_embedded_message** | **bool** | Determines if attachment is an embedded message. Read only. | -**name** | **str** | Attachment name. | [optional] -**name_encoding** | **str** | Encoding of attachment name. | [optional] -**preferred_text_encoding** | **str** | Preferred text encoding. | [optional] +**content_disposition** |**str** |Content-Disposition header. Read only. |[optional] +**is_embedded_message** |**bool** |Determines if attachment is an embedded message. Read only. | +**name** |**str** |Attachment name. |[optional] +**name_encoding** |**str** |Encoding of attachment name. |[optional] +**preferred_text_encoding** |**str** |Preferred text encoding. |[optional] - Parent class: [AttachmentBase](AttachmentBase.md) +Parent class: [AttachmentBase](AttachmentBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/AttachmentBase.md b/sdk/docs/AttachmentBase.md index fffefad..e91443d 100644 --- a/sdk/docs/AttachmentBase.md +++ b/sdk/docs/AttachmentBase.md @@ -1,14 +1,17 @@ # AsposeEmailCloudSdk.models.AttachmentBase + +AttachmentBase class + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base64_data** | **str** | Attachment file content as Base64 string. | [optional] -**content_id** | **str** | Attachment content id | [optional] -**content_type** | [**ContentType**](ContentType.md) | Content type | [optional] -**headers** | **dict(str, str)** | Attachment headers. | [optional] +**base64_data** |**str** |Attachment file content as Base64 string. |[optional] +**content_id** |**str** |Attachment content id |[optional] +**content_type** |[**ContentType**](ContentType.md) |Content type |[optional] +**headers** |**dict(str, str)** |Attachment headers. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/CalendarApi.md b/sdk/docs/CalendarApi.md index 80eb3a1..8273dde 100644 --- a/sdk/docs/CalendarApi.md +++ b/sdk/docs/CalendarApi.md @@ -1,255 +1,999 @@ -# AsposeEmailCloudSdk.CalendarApi +# AsposeEmailCloudSdk.CalendarApi (EmailCloud.calendar) + +iCalendar document operations. - -# as_alternate +## as_alternate + +Description: Convert iCalendar to AlternateView + +Returns: iCalendar document represented as AlternateView +Method call example: ```python -as_alternate(self, CalendarAsAlternateRequest request) +result = api.calendar.as_alternate(request) ``` -Convert iCalendar to AlternateView +### Parameter: request + +Description: iCalendar to AlternateView request + +See parameter model documentation at [CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) -### Return type +
+ Parameter initialization example: + +```python +request = models.CalendarAsAlternateRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'), + sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') +``` -[**AlternateView**](AlternateView.md) +
-### request Parameter +### Result -See parameter model documentation at [CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) +Description: iCalendar document represented as AlternateView + +Return type: [**AlternateView**](AlternateView.md) + +
+ Result example + +```python +result = models.AlternateView( + base64_data='', + content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', + content_type=models.ContentType( + char_set='utf-8', + media_type='text/calendar', + name='meeting.ics', + parameters=[ + models.ContentTypeParameter( + name='Method', + value='REQUEST'), + models.ContentTypeParameter( + name='Name', + value='meeting.ics'), + models.ContentTypeParameter( + name='charset', + value='utf-8')])) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarAsAlternateRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'), + sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') + +// Call method: +result = api.calendar.as_alternate(request) + +// Result example: +result = models.AlternateView( + base64_data='', + content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', + content_type=models.ContentType( + char_set='utf-8', + media_type='text/calendar', + name='meeting.ics', + parameters=[ + models.ContentTypeParameter( + name='Method', + value='REQUEST'), + models.ContentTypeParameter( + name='Name', + value='meeting.ics'), + models.ContentTypeParameter( + name='charset', + value='utf-8')])) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_file +## as_file +Description: Converts calendar model to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.calendar.as_file(request) +``` + +### Parameter: request + +Description: Calendar model and format to convert. + +See parameter model documentation at [CalendarAsFileRequest](CalendarAsFileRequest.md) + +
+ Parameter initialization example: + ```python -as_file(self, CalendarAsFileRequest request) +request = models.CalendarAsFileRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) ``` -Converts calendar model to specified format and returns as file. +
-### Return type +### Result -**Stream** +Description: File stream in specified format. -### request Parameter +Return type: **Stream** -See parameter model documentation at [CalendarAsFileRequest](CalendarAsFileRequest.md) +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarAsFileRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) + +// Call method: +result = api.calendar.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_mapi +## as_mapi +Description: Converts CalendarDto to MapiCalendarDto. + +Returns: MAPI model calendar representation. + +Method call example: ```python -as_mapi(self, CalendarDto calendar_dto) +result = api.calendar.as_mapi(calendar_dto) ``` -Converts CalendarDto to MapiCalendarDto. +### Parameter: calendar_dto -### Return type +Description: iCalendar model calendar representation. -[**MapiCalendarDto**](MapiCalendarDto.md) +See parameter model documentation at [CalendarDto](CalendarDto.md) -### calendar_dto Parameter +
+ Parameter initialization example: + +```python +calendar_dto = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` -See parameter model documentation at [CalendarDto](CalendarDto.md) +
+ +### Result + +Description: MAPI model calendar representation. + +Return type: [**MapiCalendarDto**](MapiCalendarDto.md) + +
+ Result example + +```python +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +calendar_dto = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') + +// Call method: +result = api.calendar.as_mapi(calendar_dto) + +// Result example: +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# convert +## convert + +Description: Converts calendar document to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.calendar.convert(request) +``` + +### Parameter: request + +Description: convert method request. +See parameter model documentation at [CalendarConvertRequest](CalendarConvertRequest.md). + +
+ Parameter initialization example: + ```python -convert(self, request: CalendarConvertRequest) +request = models.CalendarConvertRequest( + format='Ics', + file='/path/to/calendar.msg') ``` -Converts calendar document to specified format and returns as file. +
+ +### Result -### Return type +Description: File stream in specified format. -str +Return type: **Stream** + +### Complete example + +
+ Method call example: -### request Parameter ```python -CalendarConvertRequest( - format, - file) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarConvertRequest( + format='Ics', + file='/path/to/calendar.msg') + +// Call method: +result = api.calendar.convert(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | File format. Enum, available values: Ics, Msg | - **file** | **str** | File to convert | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts calendar document to a model representation. +Returns: iCalendar model. + +Method call example: ```python -from_file(self, request: CalendarFromFileRequest) +result = api.calendar.from_file(request) ``` -Converts calendar document to a model representation. +### Parameter: request + +Description: from_file method request. + +See parameter model documentation at [CalendarFromFileRequest](CalendarFromFileRequest.md). + +
+ Parameter initialization example: + +```python +request = models.CalendarFromFileRequest( + file='/path/to/calendar.ics') +``` + +
+ +### Result + +Description: iCalendar model. -### Return type +Return type: [**CalendarDto**](CalendarDto.md) -CalendarDto +
+ Result example -### request Parameter ```python -CalendarFromFileRequest( - file) +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') ``` +
-Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **str** | File to convert | +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarFromFileRequest( + file='/path/to/calendar.ics') + +// Call method: +result = api.calendar.from_file(request) + +// Result example: +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get +Description: Get calendar file from storage. + +Returns: iCalendar model. + +Method call example: ```python -get(self, request: CalendarGetRequest) +result = api.calendar.get(request) ``` -Get calendar file from storage. +### Parameter: request + +Description: get method request. + +See parameter model documentation at [CalendarGetRequest](CalendarGetRequest.md). + +
+ Parameter initialization example: + +```python +request = models.CalendarGetRequest( + file_name='calendar.ics', + folder='calendar/location/on/storage', + storage='First Storage') +``` + +
+ +### Result + +Description: iCalendar model. + +Return type: [**CalendarDto**](CalendarDto.md) + +
+ Result example + +```python +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` +
-### Return type +### Complete example -CalendarDto +
+ Method call example: -### request Parameter ```python -CalendarGetRequest( - file_name, - folder, - storage) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarGetRequest( + file_name='calendar.ics', + folder='calendar/location/on/storage', + storage='First Storage') + +// Call method: +result = api.calendar.get(request) + +// Result example: +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | iCalendar file name in storage. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_as_alternate +## get_as_alternate + +Description: Get iCalendar from storage as AlternateView + +Returns: iCalendar document represented as AlternateView +Method call example: ```python -get_as_alternate(self, request: CalendarGetAsAlternateRequest) +result = api.calendar.get_as_alternate(request) ``` -Get iCalendar from storage as AlternateView +### Parameter: request -### Return type +Description: get_as_alternate method request. -AlternateView +See parameter model documentation at [CalendarGetAsAlternateRequest](CalendarGetAsAlternateRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -CalendarGetAsAlternateRequest( - file_name, - calendar_action, - sequence_id, - folder, - storage) +request = models.CalendarGetAsAlternateRequest( + file_name='calendar.ics', + calendar_action='Create', + folder='calendar/location/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | iCalendar file name in storage | - **calendar_action** | **str** | iCalendar method type Enum, available values: Create, Update, Cancel | - **sequence_id** | **str** | The sequence id | [optional] - **folder** | **str** | Path to folder in storage | [optional] - **storage** | **str** | Storage name | [optional] +
+ +### Result + +Description: iCalendar document represented as AlternateView + +Return type: [**AlternateView**](AlternateView.md) + +
+ Result example + +```python +result = models.AlternateView( + base64_data='', + content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', + content_type=models.ContentType( + char_set='utf-8', + media_type='text/calendar', + name='meeting.ics', + parameters=[ + models.ContentTypeParameter( + name='Method', + value='REQUEST'), + models.ContentTypeParameter( + name='Name', + value='meeting.ics'), + models.ContentTypeParameter( + name='charset', + value='utf-8')])) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarGetAsAlternateRequest( + file_name='calendar.ics', + calendar_action='Create', + folder='calendar/location/on/storage', + storage='First Storage') + +// Call method: +result = api.calendar.get_as_alternate(request) + +// Result example: +result = models.AlternateView( + base64_data='', + content_id='fa7a8948-4af1-432a-b4d9-ee0c28542e75', + content_type=models.ContentType( + char_set='utf-8', + media_type='text/calendar', + name='meeting.ics', + parameters=[ + models.ContentTypeParameter( + name='Method', + value='REQUEST'), + models.ContentTypeParameter( + name='Name', + value='meeting.ics'), + models.ContentTypeParameter( + name='charset', + value='utf-8')])) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_as_file +## get_as_file + +Description: Converts calendar document from storage to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.calendar.get_as_file(request) +``` + +### Parameter: request + +Description: get_as_file method request. + +See parameter model documentation at [CalendarGetAsFileRequest](CalendarGetAsFileRequest.md). +
+ Parameter initialization example: + ```python -get_as_file(self, request: CalendarGetAsFileRequest) +request = models.CalendarGetAsFileRequest( + file_name='calendar.msg', + format='Ics', + storage='First Storage', + folder='calendar/file/location/on/storage') ``` -Converts calendar document from storage to specified format and returns as file. +
-### Return type +### Result -str +Description: File stream in specified format. + +Return type: **Stream** + +### Complete example + +
+ Method call example: -### request Parameter ```python -CalendarGetAsFileRequest( - file_name, - format, - storage, - folder) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarGetAsFileRequest( + file_name='calendar.msg', + format='Ics', + storage='First Storage', + folder='calendar/file/location/on/storage') + +// Call method: +result = api.calendar.get_as_file(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | Calendar document file name. | - **format** | **str** | File format. Enum, available values: Ics, Msg | - **storage** | **str** | Storage name. | [optional] - **folder** | **str** | Path to folder in storage. | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_list +## get_list +Description: Get iCalendar list from storage folder. + +Returns: iCalendar document list. + +Method call example: ```python -get_list(self, request: CalendarGetListRequest) +result = api.calendar.get_list(request) ``` -Get iCalendar list from storage folder. +### Parameter: request + +Description: get_list method request. + +See parameter model documentation at [CalendarGetListRequest](CalendarGetListRequest.md). + +
+ Parameter initialization example: + +```python +request = models.CalendarGetListRequest( + folder='some/folder/on/storage', + items_per_page=10, + page_number=0, + storage='First Storage') +``` + +
+ +### Result -### Return type +Description: iCalendar document list. -CalendarStorageList +Return type: [**CalendarStorageList**](CalendarStorageList.md) + +
+ Result example + +```python +result = models.CalendarStorageList( + value=[ + models.StorageModelOfCalendarDto( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'))]) +``` +
+ +### Complete example + +
+ Method call example: -### request Parameter ```python -CalendarGetListRequest( - folder, - items_per_page, - page_number, - storage) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarGetListRequest( + folder='some/folder/on/storage', + items_per_page=10, + page_number=0, + storage='First Storage') + +// Call method: +result = api.calendar.get_list(request) + +// Result example: +result = models.CalendarStorageList( + value=[ + models.StorageModelOfCalendarDto( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'))]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **folder** | **str** | Path to folder in storage. | - **items_per_page** | **int** | Count of items on page. | [optional] [default to 10] - **page_number** | **int** | Page number. | [optional] [default to 0] - **storage** | **str** | Storage name. | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save iCalendar +Method call example: ```python -save(self, CalendarSaveRequest request) +api.calendar.save(request) ``` -Save iCalendar +### Parameter: request -### Return type +Description: iCalendar create/update request -void (empty response body) +See parameter model documentation at [CalendarSaveRequest](CalendarSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.CalendarSaveRequest( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) +``` -See parameter model documentation at [CalendarSaveRequest](CalendarSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CalendarSaveRequest( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) + +// Call method: +api.calendar.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/CalendarApi_list.md b/sdk/docs/CalendarApi_list.md index 2b58338..8d4d95e 100644 --- a/sdk/docs/CalendarApi_list.md +++ b/sdk/docs/CalendarApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for CalendarApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/CalendarAsAlternateRequest.md b/sdk/docs/CalendarAsAlternateRequest.md index ca5e7e4..50922c3 100644 --- a/sdk/docs/CalendarAsAlternateRequest.md +++ b/sdk/docs/CalendarAsAlternateRequest.md @@ -1,13 +1,40 @@ # AsposeEmailCloudSdk.models.CalendarAsAlternateRequest + +Convert iCalendar to AlternateView request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**CalendarDto**](CalendarDto.md) | iCalendar document model | -**action** | **str** | iCalendar actions. Enum, available values: Create, Update, Cancel | -**sequence_id** | **str** | iCalendar sequence id | [optional] +**value** |[**CalendarDto**](CalendarDto.md) |iCalendar document model | +**action** |**str** |iCalendar actions. Enum, available values: Create, Update, Cancel | +**sequence_id** |**str** |iCalendar sequence id |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +calendar_as_alternate_request = models.CalendarAsAlternateRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'), + sequence_id='cf4ffb6c-895d-4e58-bdb4-0a3918e96a43') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/CalendarAsFileRequest.md b/sdk/docs/CalendarAsFileRequest.md index 6dec9cf..5e304b2 100644 --- a/sdk/docs/CalendarAsFileRequest.md +++ b/sdk/docs/CalendarAsFileRequest.md @@ -1,12 +1,38 @@ # AsposeEmailCloudSdk.models.CalendarAsFileRequest + +iCalendar model to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Calendar file format Enum, available values: Ics, Msg | -**value** | [**CalendarDto**](CalendarDto.md) | iCalendar model | +**format** |**str** |Calendar file format Enum, available values: Ics, Msg | +**value** |[**CalendarDto**](CalendarDto.md) |iCalendar model | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +calendar_as_file_request = models.CalendarAsFileRequest( + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/CalendarConvertRequest.md b/sdk/docs/CalendarConvertRequest.md new file mode 100644 index 0000000..84f342f --- /dev/null +++ b/sdk/docs/CalendarConvertRequest.md @@ -0,0 +1,17 @@ +# CalendarConvertRequest + +Request model for CalendarApi.convert + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |File format. Enum, available values: Ics, Msg | +**file** |**str** |File to convert | + +## Example +```python +request = models.CalendarConvertRequest( + format='Ics', + file='/path/to/calendar.msg') +``` diff --git a/sdk/docs/CalendarDto.md b/sdk/docs/CalendarDto.md index aa51a94..9a8d9ce 100644 --- a/sdk/docs/CalendarDto.md +++ b/sdk/docs/CalendarDto.md @@ -1,32 +1,57 @@ # AsposeEmailCloudSdk.models.CalendarDto + +iCalendar document representation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attachments** | [**list[Attachment]**](Attachment.md) | Document attachments. | [optional] -**attendees** | [**list[MailAddress]**](MailAddress.md) | Event attendees. | -**description** | **str** | Description. | [optional] -**end_date** | **datetime** | End date. | -**end_time_zone** | **str** | End time zone. | [optional] -**flags** | **list[str]** | Appointment flags. Items: Enumerates iCalendar flags. Enum, available values: None, AllDayEvent | [optional] -**is_description_html** | **bool** | Indicates if description is in HTML format. | -**location** | **str** | Location. | -**method** | **str** | Defines the iCalendar object method type associated with the calendar document. Enum, available values: None, Publish, Request, Reply, Add, Cancel, Refresh, Counter, DeclineCounter | -**microsoft_busy_status** | **str** | Specifies the BUSY status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | -**microsoft_intended_status** | **str** | Specifies the INTENDED status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | -**optional_attendees** | [**list[MailAddress]**](MailAddress.md) | Optional attendees. | [optional] -**organizer** | [**MailAddress**](MailAddress.md) | Event organizer. | -**recurrence_string** | **str** | Deprecated, use 'Recurrence' property. String representation of recurrence pattern (See iCalendar RFC, \"Recurrence rule\" section). For example: For daily recurrence: \"FREQ=DAILY;COUNT=10;WKST=MO\" For monthly recurrence: \"BYSETPOS=1;BYDAY=MO,TU,WE,TH,FR;FREQ=MONTHLY;INTERVAL=10;WKST=MO\" For yearly recurrence: \"BYMONTHDAY=30;BYMONTH=1;FREQ=YEARLY;WKST=MO\" | [optional] -**recurrence** | [**RecurrencePatternDto**](RecurrencePatternDto.md) | Recurrence pattern | [optional] -**reminders** | [**list[CalendarReminder]**](CalendarReminder.md) | Reminders. | [optional] -**sequence_id** | **str** | The sequence id. Read only. | [optional] -**start_date** | **datetime** | Start date. | -**start_time_zone** | **str** | Start time zone. | [optional] -**status** | **str** | Defines the overall status or confirmation for the calendar document. Enum, available values: NotDefined, Cancelled, Tentative, Confirmed | -**summary** | **str** | Summary. | [optional] -**transparency** | **str** | Specifies whether or not this appointment is intended to be visible in availability searches. Enum, available values: NotDefined, Transparent, Opaque | +**attachments** |[**list[Attachment]**](Attachment.md) |Document attachments. |[optional] +**attendees** |[**list[MailAddress]**](MailAddress.md) |Event attendees. | +**description** |**str** |Description. |[optional] +**end_date** |**datetime** |End date. | +**end_time_zone** |**str** |End time zone. |[optional] +**flags** |**list[str]** |Appointment flags. Items: Enumerates iCalendar flags. Enum, available values: None, AllDayEvent |[optional] +**is_description_html** |**bool** |Indicates if description is in HTML format. | +**location** |**str** |Location. | +**method** |**str** |Defines the iCalendar object method type associated with the calendar document. Enum, available values: None, Publish, Request, Reply, Add, Cancel, Refresh, Counter, DeclineCounter | +**microsoft_busy_status** |**str** |Specifies the BUSY status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | +**microsoft_intended_status** |**str** |Specifies the INTENDED status. Enum, available values: NotDefined, Free, Tentative, Busy, Oof | +**optional_attendees** |[**list[MailAddress]**](MailAddress.md) |Optional attendees. |[optional] +**organizer** |[**MailAddress**](MailAddress.md) |Event organizer. | +**recurrence_string** |**str** |Deprecated, use 'Recurrence' property. String representation of recurrence pattern (See iCalendar RFC, \"Recurrence rule\" section). For example: For daily recurrence: \"FREQ=DAILY;COUNT=10;WKST=MO\" For monthly recurrence: \"BYSETPOS=1;BYDAY=MO,TU,WE,TH,FR;FREQ=MONTHLY;INTERVAL=10;WKST=MO\" For yearly recurrence: \"BYMONTHDAY=30;BYMONTH=1;FREQ=YEARLY;WKST=MO\" |[optional] +**recurrence** |[**RecurrencePatternDto**](RecurrencePatternDto.md) |Recurrence pattern |[optional] +**reminders** |[**list[CalendarReminder]**](CalendarReminder.md) |Reminders. |[optional] +**sequence_id** |**str** |The sequence id. Read only. |[optional] +**start_date** |**datetime** |Start date. | +**start_time_zone** |**str** |Start time zone. |[optional] +**status** |**str** |Defines the overall status or confirmation for the calendar document. Enum, available values: NotDefined, Cancelled, Tentative, Confirmed | +**summary** |**str** |Summary. |[optional] +**transparency** |**str** |Specifies whether or not this appointment is intended to be visible in availability searches. Enum, available values: NotDefined, Transparent, Opaque | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +calendar_dto = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/CalendarFromFileRequest.md b/sdk/docs/CalendarFromFileRequest.md new file mode 100644 index 0000000..a8a30f6 --- /dev/null +++ b/sdk/docs/CalendarFromFileRequest.md @@ -0,0 +1,15 @@ +# CalendarFromFileRequest + +Request model for CalendarApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file** |**str** |File to convert | + +## Example +```python +request = models.CalendarFromFileRequest( + file='/path/to/calendar.ics') +``` diff --git a/sdk/docs/CalendarGetAsAlternateRequest.md b/sdk/docs/CalendarGetAsAlternateRequest.md new file mode 100644 index 0000000..56d6827 --- /dev/null +++ b/sdk/docs/CalendarGetAsAlternateRequest.md @@ -0,0 +1,22 @@ +# CalendarGetAsAlternateRequest + +Request model for CalendarApi.get_as_alternate + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |iCalendar file name in storage | +**calendar_action** |**str** |iCalendar method type Enum, available values: Create, Update, Cancel | +**sequence_id** |**str** |The sequence id |[optional] +**folder** |**str** |Path to folder in storage |[optional] +**storage** |**str** |Storage name |[optional] + +## Example +```python +request = models.CalendarGetAsAlternateRequest( + file_name='calendar.ics', + calendar_action='Create', + folder='calendar/location/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/CalendarGetAsFileRequest.md b/sdk/docs/CalendarGetAsFileRequest.md new file mode 100644 index 0000000..1c3c72c --- /dev/null +++ b/sdk/docs/CalendarGetAsFileRequest.md @@ -0,0 +1,21 @@ +# CalendarGetAsFileRequest + +Request model for CalendarApi.get_as_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |Calendar document file name. | +**format** |**str** |File format. Enum, available values: Ics, Msg | +**storage** |**str** |Storage name. |[optional] +**folder** |**str** |Path to folder in storage. |[optional] + +## Example +```python +request = models.CalendarGetAsFileRequest( + file_name='calendar.msg', + format='Ics', + storage='First Storage', + folder='calendar/file/location/on/storage') +``` diff --git a/sdk/docs/CalendarGetListRequest.md b/sdk/docs/CalendarGetListRequest.md new file mode 100644 index 0000000..a8e07e9 --- /dev/null +++ b/sdk/docs/CalendarGetListRequest.md @@ -0,0 +1,21 @@ +# CalendarGetListRequest + +Request model for CalendarApi.get_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**folder** |**str** |Path to folder in storage. | +**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] +**page_number** |**int** |Page number. |[optional] [default to 0] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.CalendarGetListRequest( + folder='some/folder/on/storage', + items_per_page=10, + page_number=0, + storage='First Storage') +``` diff --git a/sdk/docs/CalendarGetRequest.md b/sdk/docs/CalendarGetRequest.md new file mode 100644 index 0000000..c024386 --- /dev/null +++ b/sdk/docs/CalendarGetRequest.md @@ -0,0 +1,19 @@ +# CalendarGetRequest + +Request model for CalendarApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |iCalendar file name in storage. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.CalendarGetRequest( + file_name='calendar.ics', + folder='calendar/location/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/CalendarReminder.md b/sdk/docs/CalendarReminder.md index e54dd7a..e3e2d00 100644 --- a/sdk/docs/CalendarReminder.md +++ b/sdk/docs/CalendarReminder.md @@ -1,18 +1,21 @@ # AsposeEmailCloudSdk.models.CalendarReminder + +Provides a grouping of component properties that define an alarm. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**action** | **str** | Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None | -**attachments** | **list[str]** | Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content | [optional] -**attendees** | [**list[ReminderAttendee]**](ReminderAttendee.md) | Contains collection of ReminderAttendee objects. | [optional] -**description** | **str** | Provides a more complete description of the alarm. | [optional] -**duration** | **int** | Specifies the delay period in ticks, after which the alarm will repeat. | [optional] -**repeat** | **int** | Defines the number of time the alarm should be repeated, after the initial trigger. | -**summary** | **str** | Defines a short summary or subject for the alarm. | [optional] -**trigger** | [**ReminderTrigger**](ReminderTrigger.md) | Specifies when an alarm will trigger. | [optional] +**action** |**str** |Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None | +**attachments** |**list[str]** |Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content |[optional] +**attendees** |[**list[ReminderAttendee]**](ReminderAttendee.md) |Contains collection of ReminderAttendee objects. |[optional] +**description** |**str** |Provides a more complete description of the alarm. |[optional] +**duration** |**int** |Specifies the delay period in ticks, after which the alarm will repeat. |[optional] +**repeat** |**int** |Defines the number of time the alarm should be repeated, after the initial trigger. | +**summary** |**str** |Defines a short summary or subject for the alarm. |[optional] +**trigger** |[**ReminderTrigger**](ReminderTrigger.md) |Specifies when an alarm will trigger. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/CalendarSaveRequest.md b/sdk/docs/CalendarSaveRequest.md index 263beb5..81b56ff 100644 --- a/sdk/docs/CalendarSaveRequest.md +++ b/sdk/docs/CalendarSaveRequest.md @@ -1,11 +1,42 @@ # AsposeEmailCloudSdk.models.CalendarSaveRequest + +Save iCalendar to storage request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Calendar file format Enum, available values: Ics, Msg | +**format** |**str** |Calendar file format Enum, available values: Ics, Msg | - Parent class: [StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) +Parent class: [StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +calendar_save_request = models.CalendarSaveRequest( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/CalendarStorageList.md b/sdk/docs/CalendarStorageList.md index ab303a7..02b2cfa 100644 --- a/sdk/docs/CalendarStorageList.md +++ b/sdk/docs/CalendarStorageList.md @@ -1,10 +1,43 @@ # AsposeEmailCloudSdk.models.CalendarStorageList + +iCalendar models list with corresponding storage locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) +Parent class: [ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +calendar_storage_list = models.CalendarStorageList( + value=[ + models.StorageModelOfCalendarDto( + storage_file=models.StorageFileLocation( + file_name='calendar.ics', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary'))]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientAccountApi.md b/sdk/docs/ClientAccountApi.md index 3480e12..effbe0c 100644 --- a/sdk/docs/ClientAccountApi.md +++ b/sdk/docs/ClientAccountApi.md @@ -1,99 +1,391 @@ -# AsposeEmailCloudSdk.ClientAccountApi +# AsposeEmailCloudSdk.ClientAccountApi (EmailCloud.client.account) + +Email server account for built-in client operations. - -# get +## get + +Description: Get email client account from storage. + +Returns: Email client account from storage. +Method call example: ```python -get(self, request: ClientAccountGetRequest) +result = api.client.account.get(request) ``` -Get email client account from storage. +### Parameter: request -### Return type +Description: get method request. -EmailClientAccount +See parameter model documentation at [ClientAccountGetRequest](ClientAccountGetRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientAccountGetRequest( - file_name, - folder, - storage) +request = models.ClientAccountGetRequest( + file_name='email.account', + folder='email/account/location/on/storage', + storage='First Storage') +``` + +
+ +### Result + +Description: Email client account from storage. + +Return type: [**EmailClientAccount**](EmailClientAccount.md) + +
+ Result example + +```python +result = models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com')) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientAccountGetRequest( + file_name='email.account', + folder='email/account/location/on/storage', + storage='First Storage') + +// Call method: +result = api.client.account.get(request) + +// Result example: +result = models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com')) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | File name on storage. | - **folder** | **str** | Folder on storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_multi +## get_multi + +Description: Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". +Returns: Email client multi account from storage + +Method call example: ```python -get_multi(self, request: ClientAccountGetMultiRequest) +result = api.client.account.get_multi(request) ``` -Get email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". +### Parameter: request -### Return type +Description: get_multi method request. -EmailClientMultiAccount +See parameter model documentation at [ClientAccountGetMultiRequest](ClientAccountGetMultiRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientAccountGetMultiRequest( - file_name, - folder, - storage) +request = models.ClientAccountGetMultiRequest( + file_name='email.multi.account', + folder='email/account/location/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | File name on storage | - **folder** | **str** | Folder on storage | [optional] - **storage** | **str** | Storage name | [optional] +
+ +### Result + +Description: Email client multi account from storage + +Return type: [**EmailClientMultiAccount**](EmailClientMultiAccount.md) + +
+ Result example + +```python +result = models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com'))) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientAccountGetMultiRequest( + file_name='email.multi.account', + folder='email/account/location/on/storage', + storage='First Storage') + +// Call method: +result = api.client.account.get_multi(request) + +// Result example: +result = models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com'))) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save +Description: Create/update email client account file (*.account) with credentials + +Method call example: ```python -save(self, ClientAccountSaveRequest request) +api.client.account.save(request) ``` -Create/update email client account file (*.account) with credentials +### Parameter: request -### Return type +Description: Email account information -void (empty response body) +See parameter model documentation at [ClientAccountSaveRequest](ClientAccountSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientAccountSaveRequest( + storage_file=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com'))) +``` -See parameter model documentation at [ClientAccountSaveRequest](ClientAccountSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientAccountSaveRequest( + storage_file=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com'))) + +// Call method: +api.client.account.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save_multi +## save_multi + +Description: Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". +Method call example: ```python -save_multi(self, ClientAccountSaveMultiRequest request) +api.client.account.save_multi(request) ``` -Create email client multi account file (*.multi.account). Will respond error if file extension is not \".multi.account\". +### Parameter: request + +Description: Email accounts information. + +See parameter model documentation at [ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) -### Return type +
+ Parameter initialization example: + +```python +request = models.ClientAccountSaveMultiRequest( + storage_file=models.StorageFileLocation( + file_name='email.multi.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')))) +``` -void (empty response body) +
-### request Parameter +### Result -See parameter model documentation at [ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientAccountSaveMultiRequest( + storage_file=models.StorageFileLocation( + file_name='email.multi.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')))) + +// Call method: +api.client.account.save_multi(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientAccountApi_list.md b/sdk/docs/ClientAccountApi_list.md index a0ef72d..d979667 100644 --- a/sdk/docs/ClientAccountApi_list.md +++ b/sdk/docs/ClientAccountApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for ClientAccountApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/ClientAccountBaseRequest.md b/sdk/docs/ClientAccountBaseRequest.md index 1c689cc..983dc70 100644 --- a/sdk/docs/ClientAccountBaseRequest.md +++ b/sdk/docs/ClientAccountBaseRequest.md @@ -1,11 +1,14 @@ # AsposeEmailCloudSdk.models.ClientAccountBaseRequest + +Base request for Email client. Stores information about email account location. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account_location** | [**StorageFileLocation**](StorageFileLocation.md) | Email client account configuration location on storage. | +**account_location** |[**StorageFileLocation**](StorageFileLocation.md) |Email client account configuration location on storage. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientAccountGetMultiRequest.md b/sdk/docs/ClientAccountGetMultiRequest.md new file mode 100644 index 0000000..9ab5d18 --- /dev/null +++ b/sdk/docs/ClientAccountGetMultiRequest.md @@ -0,0 +1,19 @@ +# ClientAccountGetMultiRequest + +Request model for ClientAccountApi.get_multi + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |File name on storage | +**folder** |**str** |Folder on storage |[optional] +**storage** |**str** |Storage name |[optional] + +## Example +```python +request = models.ClientAccountGetMultiRequest( + file_name='email.multi.account', + folder='email/account/location/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/ClientAccountGetRequest.md b/sdk/docs/ClientAccountGetRequest.md new file mode 100644 index 0000000..e8f539e --- /dev/null +++ b/sdk/docs/ClientAccountGetRequest.md @@ -0,0 +1,19 @@ +# ClientAccountGetRequest + +Request model for ClientAccountApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |File name on storage. | +**folder** |**str** |Folder on storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.ClientAccountGetRequest( + file_name='email.account', + folder='email/account/location/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/ClientAccountSaveMultiRequest.md b/sdk/docs/ClientAccountSaveMultiRequest.md index 9ed8102..594fe87 100644 --- a/sdk/docs/ClientAccountSaveMultiRequest.md +++ b/sdk/docs/ClientAccountSaveMultiRequest.md @@ -1,10 +1,49 @@ # AsposeEmailCloudSdk.models.ClientAccountSaveMultiRequest + +Email client multi account save request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) +Parent class: [StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_account_save_multi_request = models.ClientAccountSaveMultiRequest( + storage_file=models.StorageFileLocation( + file_name='email.multi.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')))) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientAccountSaveRequest.md b/sdk/docs/ClientAccountSaveRequest.md index f016831..a9c88d6 100644 --- a/sdk/docs/ClientAccountSaveRequest.md +++ b/sdk/docs/ClientAccountSaveRequest.md @@ -1,10 +1,33 @@ # AsposeEmailCloudSdk.models.ClientAccountSaveRequest + +Email client account save request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) +Parent class: [StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_account_save_request = models.ClientAccountSaveRequest( + storage_file=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com'))) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientFolderApi.md b/sdk/docs/ClientFolderApi.md index bff40dc..9017b13 100644 --- a/sdk/docs/ClientFolderApi.md +++ b/sdk/docs/ClientFolderApi.md @@ -1,72 +1,191 @@ -# AsposeEmailCloudSdk.ClientFolderApi +# AsposeEmailCloudSdk.ClientFolderApi (EmailCloud.client.folder) + +Email client folder operations. - -# create +## create + +Description: Create new folder in email account +Method call example: ```python -create(self, ClientFolderCreateRequest request) +api.client.folder.create(request) ``` -Create new folder in email account +### Parameter: request -### Return type +Description: Create folder request -void (empty response body) +See parameter model documentation at [ClientFolderCreateRequest](ClientFolderCreateRequest.md) -### request Parameter +
+ Parameter initialization example: + +```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')) +``` -See parameter model documentation at [ClientFolderCreateRequest](ClientFolderCreateRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +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')) + +// Call method: +api.client.folder.create(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# delete +## delete + +Description: Delete a folder in email account +Method call example: ```python -delete(self, ClientFolderDeleteRequest request) +api.client.folder.delete(request) ``` -Delete a folder in email account +### Parameter: request -### Return type +Description: Delete folder request -void (empty response body) +See parameter model documentation at [ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) -### request Parameter +
+ Parameter initialization example: + +```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')) +``` -See parameter model documentation at [ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +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')) + +// Call method: +api.client.folder.delete(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_list +## get_list + +Description: Get folders list in email account + +Returns: Folders list + +Method call example: +```python +result = api.client.folder.get_list(request) +``` + +### Parameter: request + +Description: get_list method request. +See parameter model documentation at [ClientFolderGetListRequest](ClientFolderGetListRequest.md). + +
+ Parameter initialization example: + ```python -get_list(self, request: ClientFolderGetListRequest) +request = models.ClientFolderGetListRequest( + account='email.multi.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + parent_folder='INBOX') ``` -Get folders list in email account +
+ +### Result + +Description: Folders list -### Return type +Return type: [**MailServerFolderList**](MailServerFolderList.md) -MailServerFolderList +
+ Result example -### request Parameter ```python -ClientFolderGetListRequest( - account, - storage, - account_storage_folder, - parent_folder) +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientFolderGetListRequest( + account='email.multi.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + parent_folder='INBOX') + +// Call method: +result = api.client.folder.get_list(request) + +// Result example: +result = ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account** | **str** | Email account | - **storage** | **str** | Storage name where account file located | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located | [optional] - **parent_folder** | **str** | Folder in which subfolders should be listed | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientFolderApi_list.md b/sdk/docs/ClientFolderApi_list.md index c5188a4..9998c8b 100644 --- a/sdk/docs/ClientFolderApi_list.md +++ b/sdk/docs/ClientFolderApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for ClientFolderApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/ClientFolderCreateRequest.md b/sdk/docs/ClientFolderCreateRequest.md index 39f2a10..2e54776 100644 --- a/sdk/docs/ClientFolderCreateRequest.md +++ b/sdk/docs/ClientFolderCreateRequest.md @@ -1,12 +1,27 @@ # AsposeEmailCloudSdk.models.ClientFolderCreateRequest + +Email Client create folder request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**parent_folder** | **str** | Path to parent folder. | [optional] -**folder_name** | **str** | Folder name. | +**parent_folder** |**str** |Path to parent folder. |[optional] +**folder_name** |**str** |Folder name. | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_folder_create_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')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientFolderDeleteRequest.md b/sdk/docs/ClientFolderDeleteRequest.md index 4fac1fd..eb59b54 100644 --- a/sdk/docs/ClientFolderDeleteRequest.md +++ b/sdk/docs/ClientFolderDeleteRequest.md @@ -1,11 +1,25 @@ # AsposeEmailCloudSdk.models.ClientFolderDeleteRequest + +Email client delete folder request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**folder** | **str** | Path to folder to delete. | +**folder** |**str** |Path to folder to delete. | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_folder_delete_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')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientFolderGetListRequest.md b/sdk/docs/ClientFolderGetListRequest.md new file mode 100644 index 0000000..9a79bba --- /dev/null +++ b/sdk/docs/ClientFolderGetListRequest.md @@ -0,0 +1,21 @@ +# ClientFolderGetListRequest + +Request model for ClientFolderApi.get_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**account** |**str** |Email account | +**storage** |**str** |Storage name where account file located |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located |[optional] +**parent_folder** |**str** |Folder in which subfolders should be listed |[optional] + +## Example +```python +request = models.ClientFolderGetListRequest( + account='email.multi.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + parent_folder='INBOX') +``` diff --git a/sdk/docs/ClientMessageApi.md b/sdk/docs/ClientMessageApi.md index 275bcbc..371eafa 100644 --- a/sdk/docs/ClientMessageApi.md +++ b/sdk/docs/ClientMessageApi.md @@ -1,281 +1,753 @@ -# AsposeEmailCloudSdk.ClientMessageApi +# AsposeEmailCloudSdk.ClientMessageApi (EmailCloud.client.message) + +Email client message operations. - -# append +## append + +Description: Add email message to specified folder in email account. + +Returns: Message id. +Method call example: ```python -append(self, ClientMessageAppendRequest request) +result = api.client.message.append(request) ``` -Add email message to specified folder in email account. +### Parameter: request -### Return type +Description: Append email request. -[**ValueTOfString**](ValueTOfString.md) +See parameter model documentation at [ClientMessageAppendRequest](ClientMessageAppendRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientMessageAppendRequest( + folder='INBOX/SubFolder', + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + mark_as_sent=True, + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientMessageAppendRequest](ClientMessageAppendRequest.md) +
+ +### Result + +Description: Message id. + +Return type: [**ValueTOfString**](ValueTOfString.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageAppendRequest( + folder='INBOX/SubFolder', + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + mark_as_sent=True, + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +result = api.client.message.append(request) + +// Result example: +result = +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# append_file +## append_file + +Description: Add email message from file to specified folder in email account. +Returns: Message id. + +Method call example: ```python -append_file(self, request: ClientMessageAppendFileRequest) +result = api.client.message.append_file(request) ``` -Add email message from file to specified folder in email account. +### Parameter: request + +Description: append_file method request. + +See parameter model documentation at [ClientMessageAppendFileRequest](ClientMessageAppendFileRequest.md). + +
+ Parameter initialization example: + +```python +request = models.ClientMessageAppendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml', + folder='INBOX') +``` + +
+ +### Result + +Description: Message id. + +Return type: [**ValueTOfString**](ValueTOfString.md) + +
+ Result example + +```python +result = +``` +
-### Return type +### Complete example -ValueTOfString +
+ Method call example: -### request Parameter ```python -ClientMessageAppendFileRequest( - account, - file, - storage, - account_storage_folder, - format, - folder, - mark_as_sent) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageAppendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml', + folder='INBOX') + +// Call method: +result = api.client.message.append_file(request) + +// Result example: +result = ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account** | **str** | Email account. | - **file** | **str** | Message file to append. | - **storage** | **str** | Storage name where account file located. | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located. | [optional] - **format** | **str** | Email file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | [optional] [default to 0] - **folder** | **str** | Path to folder on email server to append message to. | [optional] - **mark_as_sent** | **bool** | Determines that appended message should be market as sent or not. | [optional] [default to true] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# delete +## delete +Description: Delete message. + +Method call example: ```python -delete(self, ClientMessageDeleteRequest request) +api.client.message.delete(request) ``` -Delete message. +### Parameter: request -### Return type +Description: Delete message request. -void (empty response body) +See parameter model documentation at [ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientMessageDeleteRequest( + folder='INBOX', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageDeleteRequest( + folder='INBOX', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.message.delete(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# fetch +## fetch + +Description: Fetch message from email account +Returns: MailMessageBase object that represents fetched message in requested format. + +Method call example: ```python -fetch(self, request: ClientMessageFetchRequest) +result = api.client.message.fetch(request) ``` -Fetch message from email account +### Parameter: request -### Return type +Description: fetch method request. -MailMessageBase +See parameter model documentation at [ClientMessageFetchRequest](ClientMessageFetchRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientMessageFetchRequest( - message_id, - account, - folder, - storage, - account_storage_folder, - type, - format) +request = models.ClientMessageFetchRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + type='Dto', + format='Eml') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **message_id** | **str** | Message identifier | - **account** | **str** | Email account | - **folder** | **str** | Account folder to fetch from (should be specified for some protocols such as IMAP) | [optional] - **storage** | **str** | Storage name where account file located. | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located. | [optional] - **type** | **str** | MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 | [optional] [default to 0] - **format** | **str** | Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | [optional] [default to 0] +
+ +### Result + +Description: MailMessageBase object that represents fetched message in requested format. + +Return type: [**MailMessageBase**](MailMessageBase.md) + +
+ Result example + +```python +result = models.MailMessageBase( + ) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageFetchRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + type='Dto', + format='Eml') + +// Call method: +result = api.client.message.fetch(request) + +// Result example: +result = models.MailMessageBase( + ) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# fetch_file +## fetch_file + +Description: Fetch message as file from email account +Returns: Email message file in requested format. + +Method call example: ```python -fetch_file(self, request: ClientMessageFetchFileRequest) +result = api.client.message.fetch_file(request) ``` -Fetch message as file from email account +### Parameter: request -### Return type +Description: fetch_file method request. -str +See parameter model documentation at [ClientMessageFetchFileRequest](ClientMessageFetchFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientMessageFetchFileRequest( - message_id, - account, - folder, - storage, - account_storage_folder, - format) +request = models.ClientMessageFetchFileRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **message_id** | **str** | Message identifier | - **account** | **str** | Email account | - **folder** | **str** | Account folder to fetch from (should be specified for some protocols such as IMAP) | [optional] - **storage** | **str** | Storage name where account file located. | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located. | [optional] - **format** | **str** | Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | [optional] [default to 0] +
+ +### Result + +Description: Email message file in requested format. + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageFetchFileRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') + +// Call method: +result = api.client.message.fetch_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# list +## list + +Description: Get messages from folder, filtered by query +The query string should have the following view. The example of a simple expression: '' '', where <Field Name> - the name of a message field through which filtering is made, <Comparison operator> - comparison operators, as their name implies, allow to compare message field and specified value, <Field value> - value to be compared with a message field. The number of simple expressions can make a compound one, ex.: ( & ) | , where \"&\" - logical-AND operator, \"|\" - logical-OR operator At present the following values are allowed as a field name (): \"To\" - represents a TO field of message, \"Text\" - represents string in the header or body of the message, \"Bcc\" - represents a BCC field of message, \"Body\" - represents a string in the body of message, \"Cc\" - represents a CC field of message, \"From\" - represents a From field of message, \"Subject\" - represents a string in the subject of message, \"InternalDate\" - represents an internal date of message, \"SentDate\" - represents a sent date of message Additionally, the following field names are allowed for IMAP-protocol: \"Answered\" - represents an /Answered flag of message \"Seen\" - represents a /Seen flag of message \"Flagged\" - represents a /Flagged flag of message \"Draft\" - represents a /Draft flag of message \"Deleted\" - represents a Deleted/ flag of message \"Recent\" - represents a Deleted/ flag of message \"MessageSize\" - represents a size (in bytes) of message Additionally, the following field names are allowed for Exchange: \"IsRead\" - Indicates whether the message has been read \"HasAttachment\" - Indicates whether or not the message has attachments \"IsSubmitted\" - Indicates whether the message has been submitted to the Outbox \"ContentClass\" - represents a content class of item Additionally, the following field names are allowed for pst/ost files: \"MessageClass\" - Represents a message class \"ContainerClass\" - Represents a folder container class \"Importance\" - Represents a message importance \"MessageSize\" - represents a size (in bytes) of message \"FolderName\" - represents a folder name \"ContentsCount\" - represents a total number of items in the folder \"UnreadContentsCount\" - represents the number of unread items in the folder. \"Subfolders\" - Indicates whether or not the folder has subfolders \"Read\" - the message is marked as having been read \"HasAttachment\" - the message has at least one attachment \"Unsent\" - the message is still being composed \"Unmodified\" - the message has not been modified since it was first saved (if unsent) or it was delivered (if sent) \"FromMe\" - the user receiving the message was also the user who sent the message \"Resend\" - the message includes a request for a resend operation with a non-delivery report \"NotifyRead\" - the user who sent the message has requested notification when a recipient first reads it \"NotifyUnread\" - the user who sent the message has requested notification when a recipient deletes it before reading or the Message object expires \"EverRead\" - the message has been read at least once The field value () can take the following values: For text fields - any string, For date type fields - the string of \"d-MMM-yyy\" format, ex. \"10-Feb-2009\", For flags (fields of boolean type) - either \"True\", or \"False\" + +Returns: List of MailMessageBase objects that represent fetched message in requested format. + +Method call example: ```python -list(self, request: ClientMessageListRequest) +result = api.client.message.list(request) ``` -Get messages from folder, filtered by query +### Parameter: request -The query string should have the following view. The example of a simple expression: '' '', where <Field Name> - the name of a message field through which filtering is made, <Comparison operator> - comparison operators, as their name implies, allow to compare message field and specified value, <Field value> - value to be compared with a message field. The number of simple expressions can make a compound one, ex.: ( & ) | , where \"&\" - logical-AND operator, \"|\" - logical-OR operator At present the following values are allowed as a field name (): \"To\" - represents a TO field of message, \"Text\" - represents string in the header or body of the message, \"Bcc\" - represents a BCC field of message, \"Body\" - represents a string in the body of message, \"Cc\" - represents a CC field of message, \"From\" - represents a From field of message, \"Subject\" - represents a string in the subject of message, \"InternalDate\" - represents an internal date of message, \"SentDate\" - represents a sent date of message Additionally, the following field names are allowed for IMAP-protocol: \"Answered\" - represents an /Answered flag of message \"Seen\" - represents a /Seen flag of message \"Flagged\" - represents a /Flagged flag of message \"Draft\" - represents a /Draft flag of message \"Deleted\" - represents a Deleted/ flag of message \"Recent\" - represents a Deleted/ flag of message \"MessageSize\" - represents a size (in bytes) of message Additionally, the following field names are allowed for Exchange: \"IsRead\" - Indicates whether the message has been read \"HasAttachment\" - Indicates whether or not the message has attachments \"IsSubmitted\" - Indicates whether the message has been submitted to the Outbox \"ContentClass\" - represents a content class of item Additionally, the following field names are allowed for pst/ost files: \"MessageClass\" - Represents a message class \"ContainerClass\" - Represents a folder container class \"Importance\" - Represents a message importance \"MessageSize\" - represents a size (in bytes) of message \"FolderName\" - represents a folder name \"ContentsCount\" - represents a total number of items in the folder \"UnreadContentsCount\" - represents the number of unread items in the folder. \"Subfolders\" - Indicates whether or not the folder has subfolders \"Read\" - the message is marked as having been read \"HasAttachment\" - the message has at least one attachment \"Unsent\" - the message is still being composed \"Unmodified\" - the message has not been modified since it was first saved (if unsent) or it was delivered (if sent) \"FromMe\" - the user receiving the message was also the user who sent the message \"Resend\" - the message includes a request for a resend operation with a non-delivery report \"NotifyRead\" - the user who sent the message has requested notification when a recipient first reads it \"NotifyUnread\" - the user who sent the message has requested notification when a recipient deletes it before reading or the Message object expires \"EverRead\" - the message has been read at least once The field value () can take the following values: For text fields - any string, For date type fields - the string of \"d-MMM-yyy\" format, ex. \"10-Feb-2009\", For flags (fields of boolean type) - either \"True\", or \"False\" +Description: list method request. -### Return type +See parameter model documentation at [ClientMessageListRequest](ClientMessageListRequest.md). -MailMessageBaseList +
+ Parameter initialization example: + +```python +request = models.ClientMessageListRequest( + folder='INBOX', + account='email.multi.account', + query_string='('From' Contains '.com')', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + recursive=True, + type='Dto', + format='Eml') +``` + +
+ +### Result + +Description: List of MailMessageBase objects that represent fetched message in requested format. + +Return type: [**MailMessageBaseList**](MailMessageBaseList.md) + +
+ Result example -### request Parameter ```python -ClientMessageListRequest( - folder, - account, - query_string, - storage, - account_storage_folder, - recursive, - type, - format) +result = ``` +
-Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **folder** | **str** | A folder in email account | - **account** | **str** | Email account | - **query_string** | **str** | A MailQuery search string | [optional] - **storage** | **str** | Storage name where account file located | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located | [optional] - **recursive** | **bool** | Specifies that should message be searched in subfolders recursively | [optional] [default to false] - **type** | **str** | MailMessageBase type. Using this property you can get messages in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 | [optional] [default to 0] - **format** | **str** | Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | [optional] [default to 0] +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageListRequest( + folder='INBOX', + account='email.multi.account', + query_string='('From' Contains '.com')', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + recursive=True, + type='Dto', + format='Eml') + +// Call method: +result = api.client.message.list(request) + +// Result example: +result = +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# move +## move +Description: Move message to another folder. + +Method call example: ```python -move(self, ClientMessageMoveRequest request) +api.client.message.move(request) ``` -Move message to another folder. +### Parameter: request -### Return type +Description: Move message request. -void (empty response body) +See parameter model documentation at [ClientMessageMoveRequest](ClientMessageMoveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientMessageMoveRequest( + source_folder='INBOX', + destination_folder='INBOX/SubFolder', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientMessageMoveRequest](ClientMessageMoveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageMoveRequest( + source_folder='INBOX', + destination_folder='INBOX/SubFolder', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.message.move(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# send +## send + +Description: Send an email specified by model in request. +Method call example: ```python -send(self, ClientMessageSendRequest request) +api.client.message.send(request) ``` -Send an email specified by model in request. +### Parameter: request -### Return type +Description: Send email request. -void (empty response body) +See parameter model documentation at [ClientMessageSendRequest](ClientMessageSendRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientMessageSendRequest( + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientMessageSendRequest](ClientMessageSendRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageSendRequest( + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.message.send(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# send_file +## send_file + +Description: Send an email file. + +Method call example: +```python +api.client.message.send_file(request) +``` + +### Parameter: request +Description: send_file method request. + +See parameter model documentation at [ClientMessageSendFileRequest](ClientMessageSendFileRequest.md). + +
+ Parameter initialization example: + ```python -send_file(self, request: ClientMessageSendFileRequest) +request = models.ClientMessageSendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') ``` -Send an email file. +
+ +### Result -### Return type +Return type: void (empty response body) -None +### Complete example + +
+ Method call example: -### request Parameter ```python -ClientMessageSendFileRequest( - account, - file, - storage, - account_storage_folder, - format) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageSendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') + +// Call method: +api.client.message.send_file(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account** | **str** | Email account | - **file** | **str** | File to send | - **storage** | **str** | Storage name where account file located. | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located. | [optional] - **format** | **str** | Email file format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | [optional] [default to 0] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# set_is_read +## set_is_read + +Description: Mark message as read or unread. +Method call example: ```python -set_is_read(self, ClientMessageSetIsReadRequest request) +api.client.message.set_is_read(request) ``` -Mark message as read or unread. +### Parameter: request -### Return type +Description: Delete message request. -void (empty response body) +See parameter model documentation at [ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientMessageSetIsReadRequest( + is_read=True, + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientMessageSetIsReadRequest( + is_read=True, + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.message.set_is_read(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientMessageApi_list.md b/sdk/docs/ClientMessageApi_list.md index 2e310c8..480dc58 100644 --- a/sdk/docs/ClientMessageApi_list.md +++ b/sdk/docs/ClientMessageApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for ClientMessageApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/ClientMessageAppendFileRequest.md b/sdk/docs/ClientMessageAppendFileRequest.md new file mode 100644 index 0000000..ff91037 --- /dev/null +++ b/sdk/docs/ClientMessageAppendFileRequest.md @@ -0,0 +1,26 @@ +# ClientMessageAppendFileRequest + +Request model for ClientMessageApi.append_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**account** |**str** |Email account. | +**file** |**str** |Message file to append. | +**storage** |**str** |Storage name where account file located. |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] +**format** |**str** |Email file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] +**folder** |**str** |Path to folder on email server to append message to. |[optional] +**mark_as_sent** |**bool** |Determines that appended message should be market as sent or not. |[optional] [default to true] + +## Example +```python +request = models.ClientMessageAppendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml', + folder='INBOX') +``` diff --git a/sdk/docs/ClientMessageAppendRequest.md b/sdk/docs/ClientMessageAppendRequest.md index 7d92a06..d9b0477 100644 --- a/sdk/docs/ClientMessageAppendRequest.md +++ b/sdk/docs/ClientMessageAppendRequest.md @@ -1,13 +1,50 @@ # AsposeEmailCloudSdk.models.ClientMessageAppendRequest + +Email client append message request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**folder** | **str** | Path to folder on email server to append message to. | [optional] -**message** | [**MailMessageBase**](MailMessageBase.md) | Message to append. | -**mark_as_sent** | **bool** | Determines that appended message should be market as sent or not. | +**folder** |**str** |Path to folder on email server to append message to. |[optional] +**message** |[**MailMessageBase**](MailMessageBase.md) |Message to append. | +**mark_as_sent** |**bool** |Determines that appended message should be market as sent or not. | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_message_append_request = models.ClientMessageAppendRequest( + folder='INBOX/SubFolder', + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + mark_as_sent=True, + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientMessageBaseRequest.md b/sdk/docs/ClientMessageBaseRequest.md index 907ebd9..1c27de2 100644 --- a/sdk/docs/ClientMessageBaseRequest.md +++ b/sdk/docs/ClientMessageBaseRequest.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.ClientMessageBaseRequest + +Email client message request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message_id** | **str** | Message identifier. | +**message_id** |**str** |Message identifier. | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ClientMessageDeleteRequest.md b/sdk/docs/ClientMessageDeleteRequest.md index ed546fa..a4be385 100644 --- a/sdk/docs/ClientMessageDeleteRequest.md +++ b/sdk/docs/ClientMessageDeleteRequest.md @@ -1,11 +1,26 @@ # AsposeEmailCloudSdk.models.ClientMessageDeleteRequest + +Email client delete message request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**folder** | **str** | Folder to delete message from. | [optional] +**folder** |**str** |Folder to delete message from. |[optional] - Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) +Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_message_delete_request = models.ClientMessageDeleteRequest( + folder='INBOX', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientMessageFetchFileRequest.md b/sdk/docs/ClientMessageFetchFileRequest.md new file mode 100644 index 0000000..64d5208 --- /dev/null +++ b/sdk/docs/ClientMessageFetchFileRequest.md @@ -0,0 +1,25 @@ +# ClientMessageFetchFileRequest + +Request model for ClientMessageApi.fetch_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**message_id** |**str** |Message identifier | +**account** |**str** |Email account | +**folder** |**str** |Account folder to fetch from (should be specified for some protocols such as IMAP) |[optional] +**storage** |**str** |Storage name where account file located. |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] +**format** |**str** |Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] + +## Example +```python +request = models.ClientMessageFetchFileRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') +``` diff --git a/sdk/docs/ClientMessageFetchRequest.md b/sdk/docs/ClientMessageFetchRequest.md new file mode 100644 index 0000000..1056220 --- /dev/null +++ b/sdk/docs/ClientMessageFetchRequest.md @@ -0,0 +1,27 @@ +# ClientMessageFetchRequest + +Request model for ClientMessageApi.fetch + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**message_id** |**str** |Message identifier | +**account** |**str** |Email account | +**folder** |**str** |Account folder to fetch from (should be specified for some protocols such as IMAP) |[optional] +**storage** |**str** |Storage name where account file located. |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] +**type** |**str** |MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 |[optional] [default to 0] +**format** |**str** |Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] + +## Example +```python +request = models.ClientMessageFetchRequest( + message_id='', + account='email.multi.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + type='Dto', + format='Eml') +``` diff --git a/sdk/docs/ClientMessageListRequest.md b/sdk/docs/ClientMessageListRequest.md new file mode 100644 index 0000000..6586222 --- /dev/null +++ b/sdk/docs/ClientMessageListRequest.md @@ -0,0 +1,29 @@ +# ClientMessageListRequest + +Request model for ClientMessageApi.list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**folder** |**str** |A folder in email account | +**account** |**str** |Email account | +**query_string** |**str** |A MailQuery search string |[optional] +**storage** |**str** |Storage name where account file located |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located |[optional] +**recursive** |**bool** |Specifies that should message be searched in subfolders recursively |[optional] [default to false] +**type** |**str** |MailMessageBase type. Using this property you can get messages in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string). Enum, available values: Dto, Mapi, Base64 |[optional] [default to 0] +**format** |**str** |Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] + +## Example +```python +request = models.ClientMessageListRequest( + folder='INBOX', + account='email.multi.account', + query_string='('From' Contains '.com')', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + recursive=True, + type='Dto', + format='Eml') +``` diff --git a/sdk/docs/ClientMessageMoveRequest.md b/sdk/docs/ClientMessageMoveRequest.md index fa70267..5f861b6 100644 --- a/sdk/docs/ClientMessageMoveRequest.md +++ b/sdk/docs/ClientMessageMoveRequest.md @@ -1,12 +1,28 @@ # AsposeEmailCloudSdk.models.ClientMessageMoveRequest + +Email client move message request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**source_folder** | **str** | Folder to move message from. | [optional] -**destination_folder** | **str** | Folder to move message to. | +**source_folder** |**str** |Folder to move message from. |[optional] +**destination_folder** |**str** |Folder to move message to. | - Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) +Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_message_move_request = models.ClientMessageMoveRequest( + source_folder='INBOX', + destination_folder='INBOX/SubFolder', + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientMessageSendFileRequest.md b/sdk/docs/ClientMessageSendFileRequest.md new file mode 100644 index 0000000..0b105e7 --- /dev/null +++ b/sdk/docs/ClientMessageSendFileRequest.md @@ -0,0 +1,23 @@ +# ClientMessageSendFileRequest + +Request model for ClientMessageApi.send_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**account** |**str** |Email account | +**file** |**str** |File to send | +**storage** |**str** |Storage name where account file located. |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located. |[optional] +**format** |**str** |Email file format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft |[optional] [default to 0] + +## Example +```python +request = models.ClientMessageSendFileRequest( + account='email.multi.account', + file='/path/to/message.eml', + storage='First Storage', + account_storage_folder='email/account/location/on/storage', + format='Eml') +``` diff --git a/sdk/docs/ClientMessageSendRequest.md b/sdk/docs/ClientMessageSendRequest.md index c724626..cdeb94e 100644 --- a/sdk/docs/ClientMessageSendRequest.md +++ b/sdk/docs/ClientMessageSendRequest.md @@ -1,11 +1,46 @@ # AsposeEmailCloudSdk.models.ClientMessageSendRequest + +Email client send message request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | [**MailMessageBase**](MailMessageBase.md) | Message to send | +**message** |[**MailMessageBase**](MailMessageBase.md) |Message to send | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_message_send_request = models.ClientMessageSendRequest( + message=models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])), + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientMessageSetIsReadRequest.md b/sdk/docs/ClientMessageSetIsReadRequest.md index f1069c8..3a9ab32 100644 --- a/sdk/docs/ClientMessageSetIsReadRequest.md +++ b/sdk/docs/ClientMessageSetIsReadRequest.md @@ -1,11 +1,26 @@ # AsposeEmailCloudSdk.models.ClientMessageSetIsReadRequest + +Email client mark message is read/unread request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_read** | **bool** | Message is read flag. | +**is_read** |**bool** |Message is read flag. | - Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) +Parent class: [ClientMessageBaseRequest](ClientMessageBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_message_set_is_read_request = models.ClientMessageSetIsReadRequest( + is_read=True, + message_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientThreadApi.md b/sdk/docs/ClientThreadApi.md index f1aacb0..4eaeabb 100644 --- a/sdk/docs/ClientThreadApi.md +++ b/sdk/docs/ClientThreadApi.md @@ -1,128 +1,372 @@ -# AsposeEmailCloudSdk.ClientThreadApi +# AsposeEmailCloudSdk.ClientThreadApi (EmailCloud.client.thread) + +Email client thread operations. - -# delete +## delete + +Description: Delete thread by id. All messages from thread will also be deleted. + +Method call example: +```python +api.client.thread.delete(request) +``` +### Parameter: request + +Description: Delete email thread request. + +See parameter model documentation at [ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) + +
+ Parameter initialization example: + ```python -delete(self, ClientThreadDeleteRequest request) +request = models.ClientThreadDeleteRequest( + folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) ``` -Delete thread by id. All messages from thread will also be deleted. +
-### Return type +### Result -void (empty response body) +Return type: void (empty response body) -### request Parameter +### Complete example -See parameter model documentation at [ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientThreadDeleteRequest( + folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.thread.delete(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_list +## get_list + +Description: Get message threads from folder. All messages are partly fetched (without email body and some other fields). +Returns: List of threads + +Method call example: ```python -get_list(self, request: ClientThreadGetListRequest) +result = api.client.thread.get_list(request) ``` -Get message threads from folder. All messages are partly fetched (without email body and some other fields). +### Parameter: request -### Return type +Description: get_list method request. -EmailThreadList +See parameter model documentation at [ClientThreadGetListRequest](ClientThreadGetListRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientThreadGetListRequest( - folder, - account, - storage, - account_storage_folder, - update_folder_cache, - messages_cache_limit) +request = models.ClientThreadGetListRequest( + folder='INBOX/SubFolder', + account='email.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **folder** | **str** | A folder in email account. | - **account** | **str** | Email account | - **storage** | **str** | Storage name where account file located | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located | [optional] - **update_folder_cache** | **bool** | This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account | [optional] [default to true] - **messages_cache_limit** | **int** | Limit messages cache size if CacheFile is used. Ignored in accounts without limits support | [optional] [default to 200] +
+ +### Result + +Description: List of threads + +Return type: [**EmailThreadList**](EmailThreadList.md) + +
+ Result example + +```python +result = models.EmailThreadList( + value=[ + models.EmailThread( + id='123', + subject='Some email subject', + messages=[ + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='1', + subject='Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')]), + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='3', + subject='Re: Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')])])]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientThreadGetListRequest( + folder='INBOX/SubFolder', + account='email.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') + +// Call method: +result = api.client.thread.get_list(request) + +// Result example: +result = models.EmailThreadList( + value=[ + models.EmailThread( + id='123', + subject='Some email subject', + messages=[ + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='1', + subject='Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')]), + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='3', + subject='Re: Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')])])]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_messages +## get_messages + +Description: Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned. + +Returns: Requested thread with fully fetched messages +Method call example: ```python -get_messages(self, request: ClientThreadGetMessagesRequest) +result = api.client.thread.get_messages(request) ``` -Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned. +### Parameter: request -### Return type +Description: get_messages method request. -EmailList +See parameter model documentation at [ClientThreadGetMessagesRequest](ClientThreadGetMessagesRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ClientThreadGetMessagesRequest( - thread_id, - account, - folder, - storage, - account_storage_folder) +request = models.ClientThreadGetMessagesRequest( + thread_id='5', + account='email.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **thread_id** | **str** | Thread identifier | - **account** | **str** | Email account | - **folder** | **str** | Specifies account folder to get thread from | [optional] - **storage** | **str** | Storage name where account file located | [optional] - **account_storage_folder** | **str** | Folder in storage where account file located | [optional] +
+ +### Result + +Description: Requested thread with fully fetched messages + +Return type: [**EmailList**](EmailList.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientThreadGetMessagesRequest( + thread_id='5', + account='email.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') + +// Call method: +result = api.client.thread.get_messages(request) + +// Result example: +result = +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# move +## move + +Description: Move thread to another folder. +Method call example: ```python -move(self, ClientThreadMoveRequest request) +api.client.thread.move(request) ``` -Move thread to another folder. +### Parameter: request -### Return type +Description: Move thread request. -void (empty response body) +See parameter model documentation at [ClientThreadMoveRequest](ClientThreadMoveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ClientThreadMoveRequest( + destination_folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` -See parameter model documentation at [ClientThreadMoveRequest](ClientThreadMoveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientThreadMoveRequest( + destination_folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.thread.move(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# set_is_read +## set_is_read + +Description: Mark all messages in thread as read or unread. + +Method call example: +```python +api.client.thread.set_is_read(request) +``` +### Parameter: request + +Description: Email account specifier and IsRead flag. + +See parameter model documentation at [ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) + +
+ Parameter initialization example: + ```python -set_is_read(self, ClientThreadSetIsReadRequest request) +request = models.ClientThreadSetIsReadRequest( + is_read=True, + folder='INBOX', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) ``` -Mark all messages in thread as read or unread. +
-### Return type +### Result -void (empty response body) +Return type: void (empty response body) -### request Parameter +### Complete example -See parameter model documentation at [ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ClientThreadSetIsReadRequest( + is_read=True, + folder='INBOX', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) + +// Call method: +api.client.thread.set_is_read(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientThreadApi_list.md b/sdk/docs/ClientThreadApi_list.md index a96ba1f..e01e3cb 100644 --- a/sdk/docs/ClientThreadApi_list.md +++ b/sdk/docs/ClientThreadApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for ClientThreadApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/ClientThreadBaseRequest.md b/sdk/docs/ClientThreadBaseRequest.md index bef719b..947810a 100644 --- a/sdk/docs/ClientThreadBaseRequest.md +++ b/sdk/docs/ClientThreadBaseRequest.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.ClientThreadBaseRequest + +Email client thread request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**thread_id** | **str** | Thread identifier. | +**thread_id** |**str** |Thread identifier. | - Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) +Parent class: [ClientAccountBaseRequest](ClientAccountBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ClientThreadDeleteRequest.md b/sdk/docs/ClientThreadDeleteRequest.md index d443480..b5a46d6 100644 --- a/sdk/docs/ClientThreadDeleteRequest.md +++ b/sdk/docs/ClientThreadDeleteRequest.md @@ -1,11 +1,26 @@ # AsposeEmailCloudSdk.models.ClientThreadDeleteRequest + +Delete email client thread request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**folder** | **str** | Folder on email server, where thread is stored. | [optional] +**folder** |**str** |Folder on email server, where thread is stored. |[optional] - Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) +Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_thread_delete_request = models.ClientThreadDeleteRequest( + folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientThreadGetListRequest.md b/sdk/docs/ClientThreadGetListRequest.md new file mode 100644 index 0000000..7ffa504 --- /dev/null +++ b/sdk/docs/ClientThreadGetListRequest.md @@ -0,0 +1,23 @@ +# ClientThreadGetListRequest + +Request model for ClientThreadApi.get_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**folder** |**str** |A folder in email account. | +**account** |**str** |Email account | +**storage** |**str** |Storage name where account file located |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located |[optional] +**update_folder_cache** |**bool** |This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account |[optional] [default to true] +**messages_cache_limit** |**int** |Limit messages cache size if CacheFile is used. Ignored in accounts without limits support |[optional] [default to 200] + +## Example +```python +request = models.ClientThreadGetListRequest( + folder='INBOX/SubFolder', + account='email.account', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') +``` diff --git a/sdk/docs/ClientThreadGetMessagesRequest.md b/sdk/docs/ClientThreadGetMessagesRequest.md new file mode 100644 index 0000000..c87d0d8 --- /dev/null +++ b/sdk/docs/ClientThreadGetMessagesRequest.md @@ -0,0 +1,23 @@ +# ClientThreadGetMessagesRequest + +Request model for ClientThreadApi.get_messages + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**thread_id** |**str** |Thread identifier | +**account** |**str** |Email account | +**folder** |**str** |Specifies account folder to get thread from |[optional] +**storage** |**str** |Storage name where account file located |[optional] +**account_storage_folder** |**str** |Folder in storage where account file located |[optional] + +## Example +```python +request = models.ClientThreadGetMessagesRequest( + thread_id='5', + account='email.account', + folder='INBOX', + storage='First Storage', + account_storage_folder='email/account/location/on/storage') +``` diff --git a/sdk/docs/ClientThreadMoveRequest.md b/sdk/docs/ClientThreadMoveRequest.md index b84791e..bbce353 100644 --- a/sdk/docs/ClientThreadMoveRequest.md +++ b/sdk/docs/ClientThreadMoveRequest.md @@ -1,11 +1,26 @@ # AsposeEmailCloudSdk.models.ClientThreadMoveRequest + +Email client move thread request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**destination_folder** | **str** | Email account folder to move thread to. | +**destination_folder** |**str** |Email account folder to move thread to. | - Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) +Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_thread_move_request = models.ClientThreadMoveRequest( + destination_folder='INBOX/SubFolder', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ClientThreadSetIsReadRequest.md b/sdk/docs/ClientThreadSetIsReadRequest.md index e6845dc..46f5bd4 100644 --- a/sdk/docs/ClientThreadSetIsReadRequest.md +++ b/sdk/docs/ClientThreadSetIsReadRequest.md @@ -1,12 +1,28 @@ # AsposeEmailCloudSdk.models.ClientThreadSetIsReadRequest + +Mark thread messages as read or unread request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_read** | **bool** | Message is read flag. | -**folder** | **str** | Folder on email server, where thread is stored. | [optional] +**is_read** |**bool** |Message is read flag. | +**folder** |**str** |Folder on email server, where thread is stored. |[optional] - Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) +Parent class: [ClientThreadBaseRequest](ClientThreadBaseRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +client_thread_set_is_read_request = models.ClientThreadSetIsReadRequest( + is_read=True, + folder='INBOX', + thread_id='5', + account_location=models.StorageFileLocation( + file_name='email.account', + storage='First Storage', + folder_path='file/location/folder/on/storage')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContactApi.md b/sdk/docs/ContactApi.md index c642662..8944192 100644 --- a/sdk/docs/ContactApi.md +++ b/sdk/docs/ContactApi.md @@ -1,213 +1,889 @@ -# AsposeEmailCloudSdk.ContactApi +# AsposeEmailCloudSdk.ContactApi (EmailCloud.contact) + +Contact document operations. Supported formats: VCard, MSG, WebDav - -# as_file +## as_file + +Description: Converts contact model to specified format and returns as file +Returns: File stream in specified format + +Method call example: ```python -as_file(self, ContactAsFileRequest request) +result = api.contact.as_file(request) ``` -Converts contact model to specified format and returns as file +### Parameter: request + +Description: Contact model and format to convert -### Return type +See parameter model documentation at [ContactAsFileRequest](ContactAsFileRequest.md) -**Stream** +
+ Parameter initialization example: + +```python +request = models.ContactAsFileRequest( + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) +``` -### request Parameter +
-See parameter model documentation at [ContactAsFileRequest](ContactAsFileRequest.md) +### Result + +Description: File stream in specified format + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactAsFileRequest( + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) + +// Call method: +result = api.contact.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_mapi +## as_mapi + +Description: Converts ContactDto to MapiContactDto. +Returns: MAPI model contact representation + +Method call example: ```python -as_mapi(self, ContactDto contact_dto) +result = api.contact.as_mapi(contact_dto) ``` -Converts ContactDto to MapiContactDto. +### Parameter: contact_dto + +Description: Contact model to convert -### Return type +See parameter model documentation at [ContactDto](ContactDto.md) -[**MapiContactDto**](MapiContactDto.md) +
+ Parameter initialization example: + +```python +contact_dto = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` -### contact_dto Parameter +
-See parameter model documentation at [ContactDto](ContactDto.md) +### Result + +Description: MAPI model contact representation + +Return type: [**MapiContactDto**](MapiContactDto.md) + +
+ Result example + +```python +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +contact_dto = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) + +// Call method: +result = api.contact.as_mapi(contact_dto) + +// Result example: +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# convert +## convert + +Description: Converts contact document to specified format and returns as file +Returns: File stream in specified destination format + +Method call example: ```python -convert(self, request: ContactConvertRequest) +result = api.contact.convert(request) ``` -Converts contact document to specified format and returns as file +### Parameter: request -### Return type +Description: convert method request. -str +See parameter model documentation at [ContactConvertRequest](ContactConvertRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ContactConvertRequest( - to_format, - from_format, - file) +request = models.ContactConvertRequest( + to_format='VCard', + from_format='Msg', + file='/path/to/contact.msg') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **to_format** | **str** | File format to convert to Enum, available values: VCard, WebDav, Msg | - **from_format** | **str** | File format to convert from Enum, available values: VCard, WebDav, Msg | - **file** | **str** | File to convert | +
+ +### Result + +Description: File stream in specified destination format + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactConvertRequest( + to_format='VCard', + from_format='Msg', + file='/path/to/contact.msg') + +// Call method: +result = api.contact.convert(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts contact document to a model representation + +Returns: Contact model + +Method call example: +```python +result = api.contact.from_file(request) +``` + +### Parameter: request + +Description: from_file method request. + +See parameter model documentation at [ContactFromFileRequest](ContactFromFileRequest.md). +
+ Parameter initialization example: + ```python -from_file(self, request: ContactFromFileRequest) +request = models.ContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') ``` -Converts contact document to a model representation +
-### Return type +### Result -ContactDto +Description: Contact model + +Return type: [**ContactDto**](ContactDto.md) + +
+ Result example -### request Parameter ```python -ContactFromFileRequest( - format, - file) +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) ``` +
+ +### Complete example -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | File format Enum, available values: VCard, WebDav, Msg | - **file** | **str** | File to convert | +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') + +// Call method: +result = api.contact.from_file(request) + +// Result example: +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get +Description: Get contact document from storage. + +Returns: Contact document. + +Method call example: ```python -get(self, request: ContactGetRequest) +result = api.contact.get(request) ``` -Get contact document from storage. +### Parameter: request -### Return type +Description: get method request. -ContactDto +See parameter model documentation at [ContactGetRequest](ContactGetRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ContactGetRequest( - format, - file_name, - folder, - storage) +request = models.ContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Contact document format. Enum, available values: VCard, WebDav, Msg | - **file_name** | **str** | Contact document file name. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
+ +### Result + +Description: Contact document. + +Return type: [**ContactDto**](ContactDto.md) + +
+ Result example + +```python +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') + +// Call method: +result = api.contact.get(request) + +// Result example: +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_as_file +## get_as_file + +Description: Converts contact document from storage to specified format and returns as file + +Returns: File stream in specified format + +Method call example: +```python +result = api.contact.get_as_file(request) +``` + +### Parameter: request + +Description: get_as_file method request. +See parameter model documentation at [ContactGetAsFileRequest](ContactGetAsFileRequest.md). + +
+ Parameter initialization example: + ```python -get_as_file(self, request: ContactGetAsFileRequest) +request = models.ContactGetAsFileRequest( + file_name='contact.msg', + to_format='VCard', + from_format='Msg', + storage='First Storage', + folder='folder/on/storage') ``` -Converts contact document from storage to specified format and returns as file +
+ +### Result + +Description: File stream in specified format -### Return type +Return type: **Stream** -str +### Complete example + +
+ Method call example: -### request Parameter ```python -ContactGetAsFileRequest( - file_name, - to_format, - from_format, - storage, - folder) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactGetAsFileRequest( + file_name='contact.msg', + to_format='VCard', + from_format='Msg', + storage='First Storage', + folder='folder/on/storage') + +// Call method: +result = api.contact.get_as_file(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | Calendar document file name | - **to_format** | **str** | File format Enum, available values: VCard, WebDav, Msg | - **from_format** | **str** | File format to convert from Enum, available values: VCard, WebDav, Msg | - **storage** | **str** | Storage name | [optional] - **folder** | **str** | Path to folder in storage | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_list +## get_list + +Description: Get contact list from storage folder. +Returns: Contact list. + +Method call example: ```python -get_list(self, request: ContactGetListRequest) +result = api.contact.get_list(request) ``` -Get contact list from storage folder. +### Parameter: request -### Return type +Description: get_list method request. -ContactStorageList +See parameter model documentation at [ContactGetListRequest](ContactGetListRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -ContactGetListRequest( - format, - folder, - storage, - items_per_page, - page_number) +request = models.ContactGetListRequest( + format='VCard', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Contact document format. Enum, available values: VCard, WebDav, Msg | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] - **items_per_page** | **int** | Count of items on page. | [optional] [default to 10] - **page_number** | **int** | Page number. | [optional] [default to 0] +
+ +### Result + +Description: Contact list. + +Return type: [**ContactStorageList**](ContactStorageList.md) + +
+ Result example + +```python +result = models.ContactStorageList( + value=[ + models.StorageModelOfContactDto( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]))]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactGetListRequest( + format='VCard', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) + +// Call method: +result = api.contact.get_list(request) + +// Result example: +result = models.ContactStorageList( + value=[ + models.StorageModelOfContactDto( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]))]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save contact to storage. +Method call example: ```python -save(self, ContactSaveRequest request) +api.contact.save(request) ``` -Save contact to storage. +### Parameter: request -### Return type +Description: Create/Update contact request. -void (empty response body) +See parameter model documentation at [ContactSaveRequest](ContactSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.ContactSaveRequest( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) +``` -See parameter model documentation at [ContactSaveRequest](ContactSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ContactSaveRequest( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) + +// Call method: +api.contact.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContactApi_list.md b/sdk/docs/ContactApi_list.md index 0f083e3..a2f78d0 100644 --- a/sdk/docs/ContactApi_list.md +++ b/sdk/docs/ContactApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for ContactApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/ContactAsFileRequest.md b/sdk/docs/ContactAsFileRequest.md index b45c45e..eb40f27 100644 --- a/sdk/docs/ContactAsFileRequest.md +++ b/sdk/docs/ContactAsFileRequest.md @@ -1,12 +1,50 @@ # AsposeEmailCloudSdk.models.ContactAsFileRequest + +Convert contact model to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | -**value** | [**ContactDto**](ContactDto.md) | Contact model. | +**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | +**value** |[**ContactDto**](ContactDto.md) |Contact model. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +contact_as_file_request = models.ContactAsFileRequest( + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ContactConvertRequest.md b/sdk/docs/ContactConvertRequest.md new file mode 100644 index 0000000..821310b --- /dev/null +++ b/sdk/docs/ContactConvertRequest.md @@ -0,0 +1,19 @@ +# ContactConvertRequest + +Request model for ContactApi.convert + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**to_format** |**str** |File format to convert to Enum, available values: VCard, WebDav, Msg | +**from_format** |**str** |File format to convert from Enum, available values: VCard, WebDav, Msg | +**file** |**str** |File to convert | + +## Example +```python +request = models.ContactConvertRequest( + to_format='VCard', + from_format='Msg', + file='/path/to/contact.msg') +``` diff --git a/sdk/docs/ContactDto.md b/sdk/docs/ContactDto.md index 33d189e..520a354 100644 --- a/sdk/docs/ContactDto.md +++ b/sdk/docs/ContactDto.md @@ -1,46 +1,83 @@ # AsposeEmailCloudSdk.models.ContactDto + +VCard document representation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**associated_persons** | [**list[AssociatedPerson]**](AssociatedPerson.md) | Associated persons. | [optional] -**attachments** | [**list[Attachment]**](Attachment.md) | Document attachments. | [optional] -**company_name** | **str** | Company name. | [optional] -**computer_network_name** | **str** | Computer network. | [optional] -**customer_id** | **str** | Customer id. | [optional] -**department_name** | **str** | Department name. | [optional] -**display_name** | **str** | Display name. | [optional] -**email_addresses** | [**list[EmailAddress]**](EmailAddress.md) | Person's email addresses. | [optional] -**events** | [**list[CustomerEvent]**](CustomerEvent.md) | Person's events. | [optional] -**file_as** | **str** | A name used for sorting. | [optional] -**file_as_mapping** | **str** | Specifies how to generate and recompute the value of the dispidFileAs property when other contact name properties change. Coincides MS-OXPROPS revision 16.2 from 7/31/2014. Enum, available values: Empty, DisplayName, FirstName, LastName, Organization, LastFirstMiddle, OrgLastFirstMiddle, LastFirstMiddleOrg, LastFirstMiddle2, LastFirstMiddle3, OrgLastFirstMiddle2, OrgLastFirstMiddle3, LastFirstMiddleOrg2, LastFirstMiddleOrg3, LastFirstMiddleGen, FirstMiddleLastGen, LastFirstMiddleGen2, BestMatch, AccordingToLocale, None | -**free_busy_location** | **str** | URL path from which a client can retrieve free/busy information for the contact as an iCal file. | [optional] -**gender** | **str** | Enum defines gender of a person. Enum, available values: Unspecified, Female, Male | -**given_name** | **str** | Person's given name. | [optional] -**government_id_number** | **str** | Government id number. | [optional] -**hobbies** | **str** | Person's hobbies. | [optional] -**initials** | **str** | Person's initials. | [optional] -**instant_messengers** | [**list[InstantMessengerAddress]**](InstantMessengerAddress.md) | Person's instant messenger addresses. | [optional] -**job_title** | **str** | Person's job title. | [optional] -**language** | **str** | Language. | [optional] -**location** | **str** | Person's location. | [optional] -**middle_name** | **str** | Person's middle name. | [optional] -**nickname** | **str** | Person's nickname. | [optional] -**notes** | **str** | Notes. | [optional] -**notes_format** | **str** | Defines format of a text. Enum, available values: Text, Html | -**office_location** | **str** | Office location. | [optional] -**organizational_id_number** | **str** | Contains an identifier for the mail user used within the mail user's organization. | [optional] -**phone_numbers** | [**list[PhoneNumber]**](PhoneNumber.md) | Person's phone numbers. | [optional] -**photo** | [**ContactPhoto**](ContactPhoto.md) | Person's photo. | [optional] -**physical_addresses** | [**list[PostalAddress]**](PostalAddress.md) | Person's physical addresses. | [optional] -**preferred_text_encoding** | **str** | Encoding for all text properties. | [optional] -**prefix** | **str** | A prefix of a full name such like Mr.(mister), Dr.(doctor) and so on. | [optional] -**profession** | **str** | A job position of a person in a company. | [optional] -**suffix** | **str** | A suffix of a full name such like Jr.(junior), Sr.(senior) and so on. | [optional] -**surname** | **str** | Person's surname. | [optional] -**urls** | [**list[Url]**](Url.md) | Person's urls. | [optional] +**associated_persons** |[**list[AssociatedPerson]**](AssociatedPerson.md) |Associated persons. |[optional] +**attachments** |[**list[Attachment]**](Attachment.md) |Document attachments. |[optional] +**company_name** |**str** |Company name. |[optional] +**computer_network_name** |**str** |Computer network. |[optional] +**customer_id** |**str** |Customer id. |[optional] +**department_name** |**str** |Department name. |[optional] +**display_name** |**str** |Display name. |[optional] +**email_addresses** |[**list[EmailAddress]**](EmailAddress.md) |Person's email addresses. |[optional] +**events** |[**list[CustomerEvent]**](CustomerEvent.md) |Person's events. |[optional] +**file_as** |**str** |A name used for sorting. |[optional] +**file_as_mapping** |**str** |Specifies how to generate and recompute the value of the dispidFileAs property when other contact name properties change. Coincides MS-OXPROPS revision 16.2 from 7/31/2014. Enum, available values: Empty, DisplayName, FirstName, LastName, Organization, LastFirstMiddle, OrgLastFirstMiddle, LastFirstMiddleOrg, LastFirstMiddle2, LastFirstMiddle3, OrgLastFirstMiddle2, OrgLastFirstMiddle3, LastFirstMiddleOrg2, LastFirstMiddleOrg3, LastFirstMiddleGen, FirstMiddleLastGen, LastFirstMiddleGen2, BestMatch, AccordingToLocale, None | +**free_busy_location** |**str** |URL path from which a client can retrieve free/busy information for the contact as an iCal file. |[optional] +**gender** |**str** |Enum defines gender of a person. Enum, available values: Unspecified, Female, Male | +**given_name** |**str** |Person's given name. |[optional] +**government_id_number** |**str** |Government id number. |[optional] +**hobbies** |**str** |Person's hobbies. |[optional] +**initials** |**str** |Person's initials. |[optional] +**instant_messengers** |[**list[InstantMessengerAddress]**](InstantMessengerAddress.md) |Person's instant messenger addresses. |[optional] +**job_title** |**str** |Person's job title. |[optional] +**language** |**str** |Language. |[optional] +**location** |**str** |Person's location. |[optional] +**middle_name** |**str** |Person's middle name. |[optional] +**nickname** |**str** |Person's nickname. |[optional] +**notes** |**str** |Notes. |[optional] +**notes_format** |**str** |Defines format of a text. Enum, available values: Text, Html | +**office_location** |**str** |Office location. |[optional] +**organizational_id_number** |**str** |Contains an identifier for the mail user used within the mail user's organization. |[optional] +**phone_numbers** |[**list[PhoneNumber]**](PhoneNumber.md) |Person's phone numbers. |[optional] +**photo** |[**ContactPhoto**](ContactPhoto.md) |Person's photo. |[optional] +**physical_addresses** |[**list[PostalAddress]**](PostalAddress.md) |Person's physical addresses. |[optional] +**preferred_text_encoding** |**str** |Encoding for all text properties. |[optional] +**prefix** |**str** |A prefix of a full name such like Mr.(mister), Dr.(doctor) and so on. |[optional] +**profession** |**str** |A job position of a person in a company. |[optional] +**suffix** |**str** |A suffix of a full name such like Jr.(junior), Sr.(senior) and so on. |[optional] +**surname** |**str** |Person's surname. |[optional] +**urls** |[**list[Url]**](Url.md) |Person's urls. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +contact_dto = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ContactFromFileRequest.md b/sdk/docs/ContactFromFileRequest.md new file mode 100644 index 0000000..6e6018d --- /dev/null +++ b/sdk/docs/ContactFromFileRequest.md @@ -0,0 +1,17 @@ +# ContactFromFileRequest + +Request model for ContactApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |File format Enum, available values: VCard, WebDav, Msg | +**file** |**str** |File to convert | + +## Example +```python +request = models.ContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') +``` diff --git a/sdk/docs/ContactGetAsFileRequest.md b/sdk/docs/ContactGetAsFileRequest.md new file mode 100644 index 0000000..5f73a38 --- /dev/null +++ b/sdk/docs/ContactGetAsFileRequest.md @@ -0,0 +1,23 @@ +# ContactGetAsFileRequest + +Request model for ContactApi.get_as_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |Calendar document file name | +**to_format** |**str** |File format Enum, available values: VCard, WebDav, Msg | +**from_format** |**str** |File format to convert from Enum, available values: VCard, WebDav, Msg | +**storage** |**str** |Storage name |[optional] +**folder** |**str** |Path to folder in storage |[optional] + +## Example +```python +request = models.ContactGetAsFileRequest( + file_name='contact.msg', + to_format='VCard', + from_format='Msg', + storage='First Storage', + folder='folder/on/storage') +``` diff --git a/sdk/docs/ContactGetListRequest.md b/sdk/docs/ContactGetListRequest.md new file mode 100644 index 0000000..6c41033 --- /dev/null +++ b/sdk/docs/ContactGetListRequest.md @@ -0,0 +1,23 @@ +# ContactGetListRequest + +Request model for ContactApi.get_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] +**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] +**page_number** |**int** |Page number. |[optional] [default to 0] + +## Example +```python +request = models.ContactGetListRequest( + format='VCard', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) +``` diff --git a/sdk/docs/ContactGetRequest.md b/sdk/docs/ContactGetRequest.md new file mode 100644 index 0000000..2a21187 --- /dev/null +++ b/sdk/docs/ContactGetRequest.md @@ -0,0 +1,21 @@ +# ContactGetRequest + +Request model for ContactApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | +**file_name** |**str** |Contact document file name. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.ContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/ContactList.md b/sdk/docs/ContactList.md index e5b7df8..f243ce3 100644 --- a/sdk/docs/ContactList.md +++ b/sdk/docs/ContactList.md @@ -1,10 +1,50 @@ # AsposeEmailCloudSdk.models.ContactList + +List of VCard documents + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfContactDto](ListResponseOfContactDto.md) +Parent class: [ListResponseOfContactDto](ListResponseOfContactDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +contact_list = models.ContactList( + value=[ + models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContactPhoto.md b/sdk/docs/ContactPhoto.md index e721135..7dab61d 100644 --- a/sdk/docs/ContactPhoto.md +++ b/sdk/docs/ContactPhoto.md @@ -1,13 +1,16 @@ # AsposeEmailCloudSdk.models.ContactPhoto + +Person's photo. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**photo_image_format** | **str** | MapiContact photo image format. Enum, available values: Undefined, Jpeg, Gif, Wmf, Bmp, Tiff | -**base64_data** | **str** | Photo serialized as base64 string. | -**discriminator** | **str** | | +**photo_image_format** |**str** |MapiContact photo image format. Enum, available values: Undefined, Jpeg, Gif, Wmf, Bmp, Tiff | +**base64_data** |**str** |Photo serialized as base64 string. | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContactSaveRequest.md b/sdk/docs/ContactSaveRequest.md index 684bbbe..8734c5a 100644 --- a/sdk/docs/ContactSaveRequest.md +++ b/sdk/docs/ContactSaveRequest.md @@ -1,11 +1,54 @@ # AsposeEmailCloudSdk.models.ContactSaveRequest + +Contact save to storage request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | +**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | - Parent class: [StorageModelOfContactDto](StorageModelOfContactDto.md) +Parent class: [StorageModelOfContactDto](StorageModelOfContactDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +contact_save_request = models.ContactSaveRequest( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')])) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContactStorageList.md b/sdk/docs/ContactStorageList.md index 7dbc545..e55a6f7 100644 --- a/sdk/docs/ContactStorageList.md +++ b/sdk/docs/ContactStorageList.md @@ -1,10 +1,55 @@ # AsposeEmailCloudSdk.models.ContactStorageList + +Contact models list with corresponding storage locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) +Parent class: [ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +contact_storage_list = models.ContactStorageList( + value=[ + models.StorageModelOfContactDto( + storage_file=models.StorageFileLocation( + file_name='contact.vcf', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]))]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContentType.md b/sdk/docs/ContentType.md index a5f1b26..8f328bd 100644 --- a/sdk/docs/ContentType.md +++ b/sdk/docs/ContentType.md @@ -1,15 +1,18 @@ # AsposeEmailCloudSdk.models.ContentType + +Represents a Content-Type header. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**boundary** | **str** | The boundary parameter included in the Content-Type header. | [optional] -**char_set** | **str** | CharSet parameter. | [optional] -**media_type** | **str** | The internet media type. | [optional] -**name** | **str** | Name parameter. | [optional] -**parameters** | [**list[ContentTypeParameter]**](ContentTypeParameter.md) | Full list of parameters | [optional] +**boundary** |**str** |The boundary parameter included in the Content-Type header. |[optional] +**char_set** |**str** |CharSet parameter. |[optional] +**media_type** |**str** |The internet media type. |[optional] +**name** |**str** |Name parameter. |[optional] +**parameters** |[**list[ContentTypeParameter]**](ContentTypeParameter.md) |Full list of parameters |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ContentTypeParameter.md b/sdk/docs/ContentTypeParameter.md index 2950aca..ed5077d 100644 --- a/sdk/docs/ContentTypeParameter.md +++ b/sdk/docs/ContentTypeParameter.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.ContentTypeParameter + +Content-Type header parameter + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Parameter name | [optional] -**value** | **str** | Parameter value | [optional] +**name** |**str** |Parameter name |[optional] +**value** |**str** |Parameter value |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/CopyFileRequest.md b/sdk/docs/CopyFileRequest.md new file mode 100644 index 0000000..584dbbe --- /dev/null +++ b/sdk/docs/CopyFileRequest.md @@ -0,0 +1,22 @@ +# CopyFileRequest + +Request model for FileApi.copy_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**src_path** |**str** |Source file path e.g. '/folder/file.ext' | +**dest_path** |**str** |Destination file path | +**src_storage_name** |**str** |Source storage name |[optional] +**dest_storage_name** |**str** |Destination storage name |[optional] +**version_id** |**str** |File version ID to copy |[optional] + +## Example +```python +request = models.CopyFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') +``` diff --git a/sdk/docs/CopyFolderRequest.md b/sdk/docs/CopyFolderRequest.md new file mode 100644 index 0000000..decd352 --- /dev/null +++ b/sdk/docs/CopyFolderRequest.md @@ -0,0 +1,21 @@ +# CopyFolderRequest + +Request model for FolderApi.copy_folder + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**src_path** |**str** |Source folder path e.g. '/src' | +**dest_path** |**str** |Destination folder path e.g. '/dst' | +**src_storage_name** |**str** |Source storage name |[optional] +**dest_storage_name** |**str** |Destination storage name |[optional] + +## Example +```python +request = models.CopyFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') +``` diff --git a/sdk/docs/CreateFolderRequest.md b/sdk/docs/CreateFolderRequest.md new file mode 100644 index 0000000..5376972 --- /dev/null +++ b/sdk/docs/CreateFolderRequest.md @@ -0,0 +1,17 @@ +# CreateFolderRequest + +Request model for FolderApi.create_folder + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |Folder path to create e.g. 'folder_1/folder_2/' | +**storage_name** |**str** |Storage name |[optional] + +## Example +```python +request = models.CreateFolderRequest( + path='/storage/path/to/new/folder', + storage_name='First Storage') +``` diff --git a/sdk/docs/CustomerEvent.md b/sdk/docs/CustomerEvent.md index 4464b16..3fc1634 100644 --- a/sdk/docs/CustomerEvent.md +++ b/sdk/docs/CustomerEvent.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.CustomerEvent + +Event. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [**EnumWithCustomOfEventCategory**](EnumWithCustomOfEventCategory.md) | Event category. | [optional] -**_date** | **datetime** | Event date. | +**category** |[**EnumWithCustomOfEventCategory**](EnumWithCustomOfEventCategory.md) |Event category. |[optional] +**_date** |**datetime** |Event date. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/DailyRecurrencePatternDto.md b/sdk/docs/DailyRecurrencePatternDto.md index bb29a97..1dfe9a4 100644 --- a/sdk/docs/DailyRecurrencePatternDto.md +++ b/sdk/docs/DailyRecurrencePatternDto.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.DailyRecurrencePatternDto + +Daily recurrence. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) +Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/DeleteFileRequest.md b/sdk/docs/DeleteFileRequest.md new file mode 100644 index 0000000..65d9b11 --- /dev/null +++ b/sdk/docs/DeleteFileRequest.md @@ -0,0 +1,18 @@ +# DeleteFileRequest + +Request model for FileApi.delete_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |File path e.g. '/folder/file.ext' | +**storage_name** |**str** |Storage name |[optional] +**version_id** |**str** |File version ID to delete |[optional] + +## Example +```python +request = models.DeleteFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') +``` diff --git a/sdk/docs/DeleteFolderRequest.md b/sdk/docs/DeleteFolderRequest.md new file mode 100644 index 0000000..021d337 --- /dev/null +++ b/sdk/docs/DeleteFolderRequest.md @@ -0,0 +1,19 @@ +# DeleteFolderRequest + +Request model for FolderApi.delete_folder + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |Folder path e.g. '/folder' | +**storage_name** |**str** |Storage name |[optional] +**recursive** |**bool** |Enable to delete folders, subfolders and files |[optional] [default to false] + +## Example +```python +request = models.DeleteFolderRequest( + path='/storage/path/to/folder', + storage_name='First Storage', + recursive=True) +``` diff --git a/sdk/docs/DiscUsage.md b/sdk/docs/DiscUsage.md index 08c52aa..29cee64 100644 --- a/sdk/docs/DiscUsage.md +++ b/sdk/docs/DiscUsage.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.DiscUsage + +Class for disc space information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**used_size** | **int** | Application used disc space. | -**total_size** | **int** | Total disc space. | +**used_size** |**int** |Application used disc space. | +**total_size** |**int** |Total disc space. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +disc_usage = models.DiscUsage( + used_size=1048576, + total_size=3145728) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/DiscoverEmailConfigRequest.md b/sdk/docs/DiscoverEmailConfigRequest.md index 43fe086..b2b6dac 100644 --- a/sdk/docs/DiscoverEmailConfigRequest.md +++ b/sdk/docs/DiscoverEmailConfigRequest.md @@ -1,13 +1,16 @@ # AsposeEmailCloudSdk.models.DiscoverEmailConfigRequest + +Discover email configuration request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address** | **str** | Email address to discover. | -**fast_processing** | **bool** | Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. | -**login** | **str** | Email account login. If not specified, address used as a login. | [optional] +**address** |**str** |Email address to discover. | +**fast_processing** |**bool** |Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. | +**login** |**str** |Email account login. If not specified, address used as a login. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/DisposableEmailApi.md b/sdk/docs/DisposableEmailApi.md index 9ca0647..808babf 100644 --- a/sdk/docs/DisposableEmailApi.md +++ b/sdk/docs/DisposableEmailApi.md @@ -1,28 +1,69 @@ -# AsposeEmailCloudSdk.DisposableEmailApi +# AsposeEmailCloudSdk.DisposableEmailApi (EmailCloud.disposable_email) + +Check email address is disposable operations - -# is_disposable +## is_disposable + +Description: Check email address is disposable + +Returns: true if address is disposable +Method call example: ```python -is_disposable(self, request: DisposableEmailIsDisposableRequest) +result = api.disposable_email.is_disposable(request) ``` -Check email address is disposable +### Parameter: request -### Return type +Description: is_disposable method request. -ValueTOfBoolean +See parameter model documentation at [DisposableEmailIsDisposableRequest](DisposableEmailIsDisposableRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -DisposableEmailIsDisposableRequest( - address) +request = models.DisposableEmailIsDisposableRequest( + address='example@mailcatch.com') +``` + +
+ +### Result + +Description: true if address is disposable + +Return type: [**ValueTOfBoolean**](ValueTOfBoolean.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.DisposableEmailIsDisposableRequest( + address='example@mailcatch.com') + +// Call method: +result = api.disposable_email.is_disposable(request) + +// Result example: +result = ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **address** | **str** | An email address to check | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/DisposableEmailApi_list.md b/sdk/docs/DisposableEmailApi_list.md index 3b00b7c..610a534 100644 --- a/sdk/docs/DisposableEmailApi_list.md +++ b/sdk/docs/DisposableEmailApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for DisposableEmailApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/DisposableEmailIsDisposableRequest.md b/sdk/docs/DisposableEmailIsDisposableRequest.md new file mode 100644 index 0000000..f56d229 --- /dev/null +++ b/sdk/docs/DisposableEmailIsDisposableRequest.md @@ -0,0 +1,15 @@ +# DisposableEmailIsDisposableRequest + +Request model for DisposableEmailApi.is_disposable + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**address** |**str** |An email address to check | + +## Example +```python +request = models.DisposableEmailIsDisposableRequest( + address='example@mailcatch.com') +``` diff --git a/sdk/docs/DownloadFileRequest.md b/sdk/docs/DownloadFileRequest.md new file mode 100644 index 0000000..82460b4 --- /dev/null +++ b/sdk/docs/DownloadFileRequest.md @@ -0,0 +1,18 @@ +# DownloadFileRequest + +Request model for FileApi.download_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |File path e.g. '/folder/file.ext' | +**storage_name** |**str** |Storage name |[optional] +**version_id** |**str** |File version ID to download |[optional] + +## Example +```python +request = models.DownloadFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') +``` diff --git a/sdk/docs/EmailAccountConfig.md b/sdk/docs/EmailAccountConfig.md index e808a42..85a5efa 100644 --- a/sdk/docs/EmailAccountConfig.md +++ b/sdk/docs/EmailAccountConfig.md @@ -1,18 +1,21 @@ # AsposeEmailCloudSdk.models.EmailAccountConfig + +Email account configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**display_name** | **str** | Email account display name | [optional] -**protocol_type** | **str** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | -**host** | **str** | Email account host. | [optional] -**port** | **int** | Port. | [optional] -**socket_type** | **str** | Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | -**authentication_types** | **list[str]** | Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress | [optional] -**extra_info** | [**list[NameValuePair]**](NameValuePair.md) | Extra account information. | [optional] -**is_validated** | **bool** | Determines that configuration validated. Set to false if validation skipped. | +**display_name** |**str** |Email account display name |[optional] +**protocol_type** |**str** |Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | +**host** |**str** |Email account host. |[optional] +**port** |**int** |Port. |[optional] +**socket_type** |**str** |Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | +**authentication_types** |**list[str]** |Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress |[optional] +**extra_info** |[**list[NameValuePair]**](NameValuePair.md) |Extra account information. |[optional] +**is_validated** |**bool** |Determines that configuration validated. Set to false if validation skipped. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailAccountConfigList.md b/sdk/docs/EmailAccountConfigList.md index b0b5bb9..2fe7123 100644 --- a/sdk/docs/EmailAccountConfigList.md +++ b/sdk/docs/EmailAccountConfigList.md @@ -1,10 +1,58 @@ # AsposeEmailCloudSdk.models.EmailAccountConfigList + +List of email accounts + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) +Parent class: [ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_account_config_list = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailAddress.md b/sdk/docs/EmailAddress.md index 3100c38..4438fb0 100644 --- a/sdk/docs/EmailAddress.md +++ b/sdk/docs/EmailAddress.md @@ -1,16 +1,19 @@ # AsposeEmailCloudSdk.models.EmailAddress + +Email address. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [**EnumWithCustomOfEmailAddressCategory**](EnumWithCustomOfEmailAddressCategory.md) | Address category. | [optional] -**display_name** | **str** | Display name. | [optional] -**preferred** | **bool** | Defines whether email address is preferred. | -**routing_type** | **str** | A routing type for an email. | [optional] -**address** | **str** | Email address. | -**original_address_string** | **str** | The original e-mail address string | [optional] +**category** |[**EnumWithCustomOfEmailAddressCategory**](EnumWithCustomOfEmailAddressCategory.md) |Address category. |[optional] +**display_name** |**str** |Display name. |[optional] +**preferred** |**bool** |Defines whether email address is preferred. | +**routing_type** |**str** |A routing type for an email. |[optional] +**address** |**str** |Email address. | +**original_address_string** |**str** |The original e-mail address string |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailApi.md b/sdk/docs/EmailApi.md index 735278d..adb3910 100644 --- a/sdk/docs/EmailApi.md +++ b/sdk/docs/EmailApi.md @@ -1,211 +1,811 @@ -# AsposeEmailCloudSdk.EmailApi +# AsposeEmailCloudSdk.EmailApi (EmailCloud.email) + +Email document (*.eml) operations. - -# as_file +## as_file + +Description: Converts Email model to specified format and returns as file. +Returns: File stream in specified format. + +Method call example: ```python -as_file(self, EmailAsFileRequest request) +result = api.email.as_file(request) ``` -Converts Email model to specified format and returns as file. +### Parameter: request + +Description: Email model and format to convert. -### Return type +See parameter model documentation at [EmailAsFileRequest](EmailAsFileRequest.md) -**Stream** +
+ Parameter initialization example: + +```python +request = models.EmailAsFileRequest( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) +``` -### request Parameter +
-See parameter model documentation at [EmailAsFileRequest](EmailAsFileRequest.md) +### Result + +Description: File stream in specified format. + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailAsFileRequest( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) + +// Call method: +result = api.email.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_mapi +## as_mapi + +Description: Converts EmailDto to MapiMessageDto. +Returns: MAPI model message representation + +Method call example: ```python -as_mapi(self, EmailDto email_dto) +result = api.email.as_mapi(email_dto) ``` -Converts EmailDto to MapiMessageDto. +### Parameter: email_dto + +Description: Email model to convert -### Return type +See parameter model documentation at [EmailDto](EmailDto.md) -[**MapiMessageDto**](MapiMessageDto.md) +
+ Parameter initialization example: + +```python +email_dto = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` -### email_dto Parameter +
-See parameter model documentation at [EmailDto](EmailDto.md) +### Result + +Description: MAPI model message representation + +Return type: [**MapiMessageDto**](MapiMessageDto.md) + +
+ Result example + +```python +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +email_dto = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) + +// Call method: +result = api.email.as_mapi(email_dto) + +// Result example: +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# convert +## convert + +Description: Converts email document to specified format and returns as file +Returns: File stream in specified format + +Method call example: ```python -convert(self, request: EmailConvertRequest) +result = api.email.convert(request) ``` -Converts email document to specified format and returns as file +### Parameter: request + +Description: convert method request. + +See parameter model documentation at [EmailConvertRequest](EmailConvertRequest.md). + +
+ Parameter initialization example: + +```python +request = models.EmailConvertRequest( + from_format='Msg', + to_format='Mhtml', + file='/path/to/message.msg') +``` + +
+ +### Result + +Description: File stream in specified format -### Return type +Return type: **Stream** -str +### Complete example + +
+ Method call example: -### request Parameter ```python -EmailConvertRequest( - from_format, - to_format, - file) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailConvertRequest( + from_format='Msg', + to_format='Mhtml', + file='/path/to/message.msg') + +// Call method: +result = api.email.convert(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **from_format** | **str** | File format to convert to Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **to_format** | **str** | File format to convert from Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **file** | **str** | File to convert | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts email document to a model representation +Returns: Email document model + +Method call example: ```python -from_file(self, request: EmailFromFileRequest) +result = api.email.from_file(request) ``` -Converts email document to a model representation +### Parameter: request -### Return type +Description: from_file method request. -EmailDto +See parameter model documentation at [EmailFromFileRequest](EmailFromFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -EmailFromFileRequest( - format, - file) +request = models.EmailFromFileRequest( + format='Eml', + file='/path/to/message.eml') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **file** | **str** | File to convert | +
+ +### Result + +Description: Email document model + +Return type: [**EmailDto**](EmailDto.md) + +
+ Result example + +```python +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailFromFileRequest( + format='Eml', + file='/path/to/message.eml') + +// Call method: +result = api.email.from_file(request) + +// Result example: +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get + +Description: Get email document from storage. +Returns: Email document. + +Method call example: ```python -get(self, request: EmailGetRequest) +result = api.email.get(request) ``` -Get email document from storage. +### Parameter: request + +Description: get method request. + +See parameter model documentation at [EmailGetRequest](EmailGetRequest.md). + +
+ Parameter initialization example: + +```python +request = models.EmailGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') +``` + +
+ +### Result + +Description: Email document. + +Return type: [**EmailDto**](EmailDto.md) + +
+ Result example -### Return type +```python +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` +
-EmailDto +### Complete example + +
+ Method call example: -### request Parameter ```python -EmailGetRequest( - format, - file_name, - folder, - storage) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') + +// Call method: +result = api.email.get(request) + +// Result example: +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **file_name** | **str** | Email document file name. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_as_file +## get_as_file + +Description: Converts email document from storage to specified format and returns as file +Returns: File stream in specified format + +Method call example: ```python -get_as_file(self, request: EmailGetAsFileRequest) +result = api.email.get_as_file(request) ``` -Converts email document from storage to specified format and returns as file +### Parameter: request -### Return type +Description: get_as_file method request. -str +See parameter model documentation at [EmailGetAsFileRequest](EmailGetAsFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -EmailGetAsFileRequest( - file_name, - format, - storage, - folder) +request = models.EmailGetAsFileRequest( + file_name='email.eml', + format='Mhtml', + storage='First Storage', + folder='folder/on/storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | Email document file name | - **format** | **str** | File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **storage** | **str** | Storage name | [optional] - **folder** | **str** | Path to folder in storage | [optional] +
+ +### Result + +Description: File stream in specified format + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailGetAsFileRequest( + file_name='email.eml', + format='Mhtml', + storage='First Storage', + folder='folder/on/storage') + +// Call method: +result = api.email.get_as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_list +## get_list + +Description: Get email list from storage folder. +Returns: Email document list. + +Method call example: ```python -get_list(self, request: EmailGetListRequest) +result = api.email.get_list(request) ``` -Get email list from storage folder. +### Parameter: request -### Return type +Description: get_list method request. -EmailStorageList +See parameter model documentation at [EmailGetListRequest](EmailGetListRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -EmailGetListRequest( - format, - folder, - storage, - items_per_page, - page_number) +request = models.EmailGetListRequest( + format='Eml', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] - **items_per_page** | **int** | Count of items on page. | [optional] [default to 10] - **page_number** | **int** | Page number. | [optional] [default to 0] +
+ +### Result + +Description: Email document list. + +Return type: [**EmailStorageList**](EmailStorageList.md) + +
+ Result example + +```python +result = models.EmailStorageList( + value=[ + models.EmailSaveRequest( + storage_file=models.StorageFileLocation( + file_name='message.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]))]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailGetListRequest( + format='Eml', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) + +// Call method: +result = api.email.get_list(request) + +// Result example: +result = models.EmailStorageList( + value=[ + models.EmailSaveRequest( + storage_file=models.StorageFileLocation( + file_name='message.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]))]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save email document to storage. +Method call example: ```python -save(self, EmailSaveRequest request) +api.email.save(request) ``` -Save email document to storage. +### Parameter: request -### Return type +Description: Email document create/update request. -void (empty response body) +See parameter model documentation at [EmailSaveRequest](EmailSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.EmailSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='email.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) +``` -See parameter model documentation at [EmailSaveRequest](EmailSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='email.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) + +// Call method: +api.email.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailApi_list.md b/sdk/docs/EmailApi_list.md index e765293..3e45826 100644 --- a/sdk/docs/EmailApi_list.md +++ b/sdk/docs/EmailApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for EmailApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/EmailAsFileRequest.md b/sdk/docs/EmailAsFileRequest.md index 9453e34..ed3de3d 100644 --- a/sdk/docs/EmailAsFileRequest.md +++ b/sdk/docs/EmailAsFileRequest.md @@ -1,12 +1,41 @@ # AsposeEmailCloudSdk.models.EmailAsFileRequest + +Convert email model to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**value** | [**EmailDto**](EmailDto.md) | Email model. | +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**value** |[**EmailDto**](EmailDto.md) |Email model. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_as_file_request = models.EmailAsFileRequest( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailClientAccount.md b/sdk/docs/EmailClientAccount.md index 1c01756..caf21d8 100644 --- a/sdk/docs/EmailClientAccount.md +++ b/sdk/docs/EmailClientAccount.md @@ -1,16 +1,33 @@ # AsposeEmailCloudSdk.models.EmailClientAccount + +A universal email client account + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**host** | **str** | Mail server host name or IP address | -**port** | **int** | Mail server port | -**security_options** | **str** | Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | -**protocol_type** | **str** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | -**credentials** | [**EmailClientAccountCredentials**](EmailClientAccountCredentials.md) | Email client account credentials | -**cache_file** | [**StorageFileLocation**](StorageFileLocation.md) | File with messages cache. Used to provide extra functions, which are not supported by account | [optional] +**host** |**str** |Mail server host name or IP address | +**port** |**int** |Mail server port | +**security_options** |**str** |Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | +**protocol_type** |**str** |Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | +**credentials** |[**EmailClientAccountCredentials**](EmailClientAccountCredentials.md) |Email client account credentials | +**cache_file** |[**StorageFileLocation**](StorageFileLocation.md) |File with messages cache. Used to provide extra functions, which are not supported by account |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_client_account = models.EmailClientAccount( + host='smtp.example.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@example.com')) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailClientAccountCredentials.md b/sdk/docs/EmailClientAccountCredentials.md index 7f320a2..b8fa68d 100644 --- a/sdk/docs/EmailClientAccountCredentials.md +++ b/sdk/docs/EmailClientAccountCredentials.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.EmailClientAccountCredentials + +Represents email client account credentials + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**login** | **str** | Email client account login | -**discriminator** | **str** | | +**login** |**str** |Email client account login | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailClientAccountOauthCredentials.md b/sdk/docs/EmailClientAccountOauthCredentials.md index 6a9c2a4..bba23f4 100644 --- a/sdk/docs/EmailClientAccountOauthCredentials.md +++ b/sdk/docs/EmailClientAccountOauthCredentials.md @@ -1,14 +1,18 @@ # AsposeEmailCloudSdk.models.EmailClientAccountOauthCredentials + +Represents email client account OAuth 2.0 credentials + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**client_id** | **str** | The client ID obtained from the Google Cloud Console during application registration. | -**client_secret** | **str** | The client secret obtained during application registration. | -**refresh_token** | **str** | OAuth 2.0 refresh token | -**request_url** | **str** | The url to obtain access token. If not specified, will try to discover from email client account host. | [optional] +**client_id** |**str** |The client ID obtained from the Google Cloud Console during application registration. | +**client_secret** |**str** |The client secret obtained during application registration. | +**refresh_token** |**str** |OAuth 2.0 refresh token | +**request_url** |**str** |The url to obtain access token. If not specified, will try to discover from email client account host. |[optional] - Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) +Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailClientAccountPasswordCredentials.md b/sdk/docs/EmailClientAccountPasswordCredentials.md index 5b68f02..312e98c 100644 --- a/sdk/docs/EmailClientAccountPasswordCredentials.md +++ b/sdk/docs/EmailClientAccountPasswordCredentials.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.EmailClientAccountPasswordCredentials + +Represents email client account password credentials + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**password** | **str** | Email client account password | +**password** |**str** |Email client account password | - Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) +Parent class: [EmailClientAccountCredentials](EmailClientAccountCredentials.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailClientMultiAccount.md b/sdk/docs/EmailClientMultiAccount.md index e46dd80..e683b97 100644 --- a/sdk/docs/EmailClientMultiAccount.md +++ b/sdk/docs/EmailClientMultiAccount.md @@ -1,12 +1,45 @@ # AsposeEmailCloudSdk.models.EmailClientMultiAccount + +Email client virtual account, which contains several accounts + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**receive_accounts** | [**list[EmailClientAccount]**](EmailClientAccount.md) | Email client receive accounts | -**send_account** | [**EmailClientAccount**](EmailClientAccount.md) | Email client send account | [optional] +**receive_accounts** |[**list[EmailClientAccount]**](EmailClientAccount.md) |Email client receive accounts | +**send_account** |[**EmailClientAccount**](EmailClientAccount.md) |Email client send account |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_client_multi_account = models.EmailClientMultiAccount( + receive_accounts=[ + models.EmailClientAccount( + host='imap.gmail.com', + port=993, + security_options='SSLAuto', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com')), + models.EmailClientAccount( + host='exchange@outlook.com', + port=443, + protocol_type='EWS', + credentials=models.EmailClientAccountOauthCredentials( + client_id='clientId', + client_secret='clientSecret', + refresh_token='refreshToken', + login='example@outlook.com'))], + send_account=models.EmailClientAccount( + host='smtp.gmail.com', + port=465, + security_options='SSLAuto', + protocol_type='SMTP', + credentials=models.EmailClientAccountPasswordCredentials( + password='password', + login='example@gmail.com'))) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailConfigApi.md b/sdk/docs/EmailConfigApi.md index 49c6e5f..0d71ad5 100644 --- a/sdk/docs/EmailConfigApi.md +++ b/sdk/docs/EmailConfigApi.md @@ -1,68 +1,441 @@ -# AsposeEmailCloudSdk.EmailConfigApi +# AsposeEmailCloudSdk.EmailConfigApi (EmailCloud.email_config) + +Email server configuration discovery. - -# discover +## discover + +Description: Discover email accounts by email address. Does not validate discovered accounts. + +Returns: Discovered account configurations. + +Method call example: +```python +result = api.email_config.discover(request) +``` + +### Parameter: request + +Description: discover method request. +See parameter model documentation at [EmailConfigDiscoverRequest](EmailConfigDiscoverRequest.md). + +
+ Parameter initialization example: + ```python -discover(self, request: EmailConfigDiscoverRequest) +request = models.EmailConfigDiscoverRequest() ``` -Discover email accounts by email address. Does not validate discovered accounts. +
+ +### Result + +Description: Discovered account configurations. + +Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) + +
+ Result example + +```python +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` +
-### Return type +### Complete example -EmailAccountConfigList +
+ Method call example: -### request Parameter ```python -EmailConfigDiscoverRequest( - address, - fast_processing) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailConfigDiscoverRequest() + +// Call method: +result = api.email_config.discover(request) + +// Result example: +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **address** | **str** | Email address. | - **fast_processing** | **bool** | Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. | [optional] [default to false] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# discover_oauth +## discover_oauth + +Description: Discover email accounts by email address. Validates discovered accounts using OAuth 2.0. + +Returns: Discovered account configurations. + +Method call example: +```python +result = api.email_config.discover_oauth(request) +``` +### Parameter: request + +Description: Discover email configuration request. + +See parameter model documentation at [EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) + +
+ Parameter initialization example: + ```python -discover_oauth(self, EmailConfigDiscoverOauthRequest request) +request = models.EmailConfigDiscoverOauthRequest( + client_id='ClientId', + client_secret='ClientSecret', + refresh_token='RefreshToken', + address='example@aspose.com', + fast_processing=True) ``` -Discover email accounts by email address. Validates discovered accounts using OAuth 2.0. +
-### Return type +### Result -[**EmailAccountConfigList**](EmailAccountConfigList.md) +Description: Discovered account configurations. -### request Parameter +Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) -See parameter model documentation at [EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) +
+ Result example + +```python +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailConfigDiscoverOauthRequest( + client_id='ClientId', + client_secret='ClientSecret', + refresh_token='RefreshToken', + address='example@aspose.com', + fast_processing=True) + +// Call method: +result = api.email_config.discover_oauth(request) + +// Result example: +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# discover_password +## discover_password + +Description: Discover email accounts by email address. Validates discovered accounts using login and password. +Returns: Discovered account configurations. + +Method call example: ```python -discover_password(self, EmailConfigDiscoverPasswordRequest request) +result = api.email_config.discover_password(request) ``` -Discover email accounts by email address. Validates discovered accounts using login and password. +### Parameter: request + +Description: Discover email configuration request. -### Return type +See parameter model documentation at [EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) -[**EmailAccountConfigList**](EmailAccountConfigList.md) +
+ Parameter initialization example: + +```python +request = models.EmailConfigDiscoverPasswordRequest( + password='password', + address='example@aspose.com', + fast_processing=True) +``` -### request Parameter +
-See parameter model documentation at [EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) +### Result + +Description: Discovered account configurations. + +Return type: [**EmailAccountConfigList**](EmailAccountConfigList.md) + +
+ Result example + +```python +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.EmailConfigDiscoverPasswordRequest( + password='password', + address='example@aspose.com', + fast_processing=True) + +// Call method: +result = api.email_config.discover_password(request) + +// Result example: +result = models.EmailAccountConfigList( + value=[ + models.EmailAccountConfig( + display_name='Google Mail', + host='imap.gmail.com', + port=993, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='SMTP', + host='smtp.gmail.com', + port=465, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')]), + models.EmailAccountConfig( + display_name='Google Mail', + protocol_type='POP3', + host='pop.gmail.com', + port=995, + socket_type='SSLAuto', + authentication_types=[ + 'PasswordCleartext', + 'OAuth2'], + extra_info=[ + models.NameValuePair( + name='Enable: You need to enable IMAP access', + value='https://mail.google.com/mail/?ui=2&shva=1#settings/fwdandpop')])]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailConfigApi_list.md b/sdk/docs/EmailConfigApi_list.md index b9864ac..e45bf09 100644 --- a/sdk/docs/EmailConfigApi_list.md +++ b/sdk/docs/EmailConfigApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for EmailConfigApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/EmailConfigDiscoverOauthRequest.md b/sdk/docs/EmailConfigDiscoverOauthRequest.md index a4c37e9..2a37d75 100644 --- a/sdk/docs/EmailConfigDiscoverOauthRequest.md +++ b/sdk/docs/EmailConfigDiscoverOauthRequest.md @@ -1,14 +1,26 @@ # AsposeEmailCloudSdk.models.EmailConfigDiscoverOauthRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**client_id** | **str** | OAuth client id. | -**client_secret** | **str** | OAuth client secret. | -**refresh_token** | **str** | OAuth refresh token. | -**request_url** | **str** | The url to obtain access token. If not specified, will be discovered from email configuration. | [optional] +**client_id** |**str** |OAuth client id. | +**client_secret** |**str** |OAuth client secret. | +**refresh_token** |**str** |OAuth refresh token. | +**request_url** |**str** |The url to obtain access token. If not specified, will be discovered from email configuration. |[optional] - Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) +Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_config_discover_oauth_request = models.EmailConfigDiscoverOauthRequest( + client_id='ClientId', + client_secret='ClientSecret', + refresh_token='RefreshToken', + address='example@aspose.com', + fast_processing=True) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailConfigDiscoverPasswordRequest.md b/sdk/docs/EmailConfigDiscoverPasswordRequest.md index cb0b555..d9c3c66 100644 --- a/sdk/docs/EmailConfigDiscoverPasswordRequest.md +++ b/sdk/docs/EmailConfigDiscoverPasswordRequest.md @@ -1,11 +1,21 @@ # AsposeEmailCloudSdk.models.EmailConfigDiscoverPasswordRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**password** | **str** | Email account password. | +**password** |**str** |Email account password. | - Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) +Parent class: [DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_config_discover_password_request = models.EmailConfigDiscoverPasswordRequest( + password='password', + address='example@aspose.com', + fast_processing=True) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailConfigDiscoverRequest.md b/sdk/docs/EmailConfigDiscoverRequest.md new file mode 100644 index 0000000..af31ef0 --- /dev/null +++ b/sdk/docs/EmailConfigDiscoverRequest.md @@ -0,0 +1,15 @@ +# EmailConfigDiscoverRequest + +Request model for EmailConfigApi.discover + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**address** |**str** |Email address. | +**fast_processing** |**bool** |Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned. |[optional] [default to false] + +## Example +```python +request = models.EmailConfigDiscoverRequest() +``` diff --git a/sdk/docs/EmailConvertRequest.md b/sdk/docs/EmailConvertRequest.md new file mode 100644 index 0000000..8afe307 --- /dev/null +++ b/sdk/docs/EmailConvertRequest.md @@ -0,0 +1,19 @@ +# EmailConvertRequest + +Request model for EmailApi.convert + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**from_format** |**str** |File format to convert to Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**to_format** |**str** |File format to convert from Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**file** |**str** |File to convert | + +## Example +```python +request = models.EmailConvertRequest( + from_format='Msg', + to_format='Mhtml', + file='/path/to/message.msg') +``` diff --git a/sdk/docs/EmailDto.md b/sdk/docs/EmailDto.md index 7e65eaa..d7bb9a2 100644 --- a/sdk/docs/EmailDto.md +++ b/sdk/docs/EmailDto.md @@ -1,42 +1,70 @@ # AsposeEmailCloudSdk.models.EmailDto + +Email message representation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**alternate_views** | [**list[AlternateView]**](AlternateView.md) | Collection of alternate views of message. | [optional] -**attachments** | [**list[Attachment]**](Attachment.md) | Email message attachments. | [optional] -**bcc** | [**list[MailAddress]**](MailAddress.md) | BCC recipients. | [optional] -**body** | **str** | Email message body as plain text. | [optional] -**body_encoding** | **str** | Body encoding. | [optional] -**body_type** | **str** | The content type of message body. Enum, available values: PlainText, Html, Rtf | -**cc** | [**list[MailAddress]**](MailAddress.md) | CC recipients. | [optional] -**_date** | **datetime** | Message date. | -**delivery_notification_options** | **list[str]** | Delivery notifications. Items: Email delivery notification options. Enum, available values: Delay, Never, None, OnFailure, OnSuccess | [optional] -**_from** | [**MailAddress**](MailAddress.md) | From address. | [optional] -**headers** | **dict(str, str)** | Document headers. | [optional] -**html_body** | **str** | HTML body. | [optional] -**html_body_text** | **str** | Html body as plain text. Read only. | [optional] -**is_body_html** | **bool** | Indicates whether the message body is in Html. | -**is_draft** | **bool** | Indicates whether or not a message has been sent. | -**is_encrypted** | **bool** | Indicates whether the message is encrypted. Read only. | -**is_signed** | **bool** | Indicates whether the message is signed. Read only. | -**linked_resources** | [**list[LinkedResource]**](LinkedResource.md) | Linked resources of message. | [optional] -**message_id** | **str** | Message id. | [optional] -**original_is_tnef** | **bool** | Indicates whether original EML message is in TNEF format. Read only. | -**preferred_text_encoding** | **str** | Preferred encoding. | [optional] -**priority** | **str** | Email priority status. Enum, available values: High, Low, Normal | -**read_receipt_to** | [**list[MailAddress]**](MailAddress.md) | Read receipt addresses. | [optional] -**reply_to_list** | [**list[MailAddress]**](MailAddress.md) | The list of addresses to reply to for the mail message. | [optional] -**reverse_path** | [**MailAddress**](MailAddress.md) | ReversePath address. | [optional] -**sender** | [**MailAddress**](MailAddress.md) | Sender address. | [optional] -**sensitivity** | **str** | Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential | -**subject** | **str** | Message subject. | [optional] -**subject_encoding** | **str** | Subject encoding. | [optional] -**time_zone_offset** | **int** | Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond). | [optional] -**to** | [**list[MailAddress]**](MailAddress.md) | The address collection that contains the recipients of message. | [optional] -**x_mailer** | **str** | The X-Mailer the software that created the e-mail message. | [optional] +**alternate_views** |[**list[AlternateView]**](AlternateView.md) |Collection of alternate views of message. |[optional] +**attachments** |[**list[Attachment]**](Attachment.md) |Email message attachments. |[optional] +**bcc** |[**list[MailAddress]**](MailAddress.md) |BCC recipients. |[optional] +**body** |**str** |Email message body as plain text. |[optional] +**body_encoding** |**str** |Body encoding. |[optional] +**body_type** |**str** |The content type of message body. Enum, available values: PlainText, Html, Rtf | +**cc** |[**list[MailAddress]**](MailAddress.md) |CC recipients. |[optional] +**_date** |**datetime** |Message date. | +**delivery_notification_options** |**list[str]** |Delivery notifications. Items: Email delivery notification options. Enum, available values: Delay, Never, None, OnFailure, OnSuccess |[optional] +**_from** |[**MailAddress**](MailAddress.md) |From address. |[optional] +**headers** |**dict(str, str)** |Document headers. |[optional] +**html_body** |**str** |HTML body. |[optional] +**html_body_text** |**str** |Html body as plain text. Read only. |[optional] +**is_body_html** |**bool** |Indicates whether the message body is in Html. | +**is_draft** |**bool** |Indicates whether or not a message has been sent. | +**is_encrypted** |**bool** |Indicates whether the message is encrypted. Read only. | +**is_signed** |**bool** |Indicates whether the message is signed. Read only. | +**linked_resources** |[**list[LinkedResource]**](LinkedResource.md) |Linked resources of message. |[optional] +**message_id** |**str** |Message id. |[optional] +**original_is_tnef** |**bool** |Indicates whether original EML message is in TNEF format. Read only. | +**preferred_text_encoding** |**str** |Preferred encoding. |[optional] +**priority** |**str** |Email priority status. Enum, available values: High, Low, Normal | +**read_receipt_to** |[**list[MailAddress]**](MailAddress.md) |Read receipt addresses. |[optional] +**reply_to_list** |[**list[MailAddress]**](MailAddress.md) |The list of addresses to reply to for the mail message. |[optional] +**reverse_path** |[**MailAddress**](MailAddress.md) |ReversePath address. |[optional] +**sender** |[**MailAddress**](MailAddress.md) |Sender address. |[optional] +**sensitivity** |**str** |Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential | +**subject** |**str** |Message subject. |[optional] +**subject_encoding** |**str** |Subject encoding. |[optional] +**time_zone_offset** |**int** |Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond). |[optional] +**to** |[**list[MailAddress]**](MailAddress.md) |The address collection that contains the recipients of message. |[optional] +**x_mailer** |**str** |The X-Mailer the software that created the e-mail message. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_dto = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailFromFileRequest.md b/sdk/docs/EmailFromFileRequest.md new file mode 100644 index 0000000..690d406 --- /dev/null +++ b/sdk/docs/EmailFromFileRequest.md @@ -0,0 +1,17 @@ +# EmailFromFileRequest + +Request model for EmailApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** | Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**file** |**str** |File to convert | + +## Example +```python +request = models.EmailFromFileRequest( + format='Eml', + file='/path/to/message.eml') +``` diff --git a/sdk/docs/EmailGetAsFileRequest.md b/sdk/docs/EmailGetAsFileRequest.md new file mode 100644 index 0000000..c9169f8 --- /dev/null +++ b/sdk/docs/EmailGetAsFileRequest.md @@ -0,0 +1,21 @@ +# EmailGetAsFileRequest + +Request model for EmailApi.get_as_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |Email document file name | +**format** |**str** |File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**storage** |**str** |Storage name |[optional] +**folder** |**str** |Path to folder in storage |[optional] + +## Example +```python +request = models.EmailGetAsFileRequest( + file_name='email.eml', + format='Mhtml', + storage='First Storage', + folder='folder/on/storage') +``` diff --git a/sdk/docs/EmailGetListRequest.md b/sdk/docs/EmailGetListRequest.md new file mode 100644 index 0000000..dda34a9 --- /dev/null +++ b/sdk/docs/EmailGetListRequest.md @@ -0,0 +1,23 @@ +# EmailGetListRequest + +Request model for EmailApi.get_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] +**items_per_page** |**int** |Count of items on page. |[optional] [default to 10] +**page_number** |**int** |Page number. |[optional] [default to 0] + +## Example +```python +request = models.EmailGetListRequest( + format='Eml', + folder='folder/on/storage', + storage='First Storage', + items_per_page=10, + page_number=0) +``` diff --git a/sdk/docs/EmailGetRequest.md b/sdk/docs/EmailGetRequest.md new file mode 100644 index 0000000..d801395 --- /dev/null +++ b/sdk/docs/EmailGetRequest.md @@ -0,0 +1,21 @@ +# EmailGetRequest + +Request model for EmailApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**file_name** |**str** |Email document file name. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.EmailGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/EmailList.md b/sdk/docs/EmailList.md index 3aba2c9..fa349dc 100644 --- a/sdk/docs/EmailList.md +++ b/sdk/docs/EmailList.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.EmailList + +Email document list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfEmailDto](ListResponseOfEmailDto.md) +Parent class: [ListResponseOfEmailDto](ListResponseOfEmailDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailSaveRequest.md b/sdk/docs/EmailSaveRequest.md index 45c00bf..76f4a56 100644 --- a/sdk/docs/EmailSaveRequest.md +++ b/sdk/docs/EmailSaveRequest.md @@ -1,11 +1,46 @@ # AsposeEmailCloudSdk.models.EmailSaveRequest + +Email save to storage request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - Parent class: [StorageModelOfEmailDto](StorageModelOfEmailDto.md) +Parent class: [StorageModelOfEmailDto](StorageModelOfEmailDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_save_request = models.EmailSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='email.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailStorageList.md b/sdk/docs/EmailStorageList.md index 334f48d..64eae94 100644 --- a/sdk/docs/EmailStorageList.md +++ b/sdk/docs/EmailStorageList.md @@ -1,10 +1,46 @@ # AsposeEmailCloudSdk.models.EmailStorageList + +Email models list with corresponding storage locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) +Parent class: [ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_storage_list = models.EmailStorageList( + value=[ + models.EmailSaveRequest( + storage_file=models.StorageFileLocation( + file_name='message.eml', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]))]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EmailThread.md b/sdk/docs/EmailThread.md index f6efa48..dc27753 100644 --- a/sdk/docs/EmailThread.md +++ b/sdk/docs/EmailThread.md @@ -1,14 +1,69 @@ # AsposeEmailCloudSdk.models.EmailThread + +Email messages thread + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Thread identifier | [optional] -**subject** | **str** | Thread subject | [optional] -**messages** | [**list[EmailDto]**](EmailDto.md) | List of messages in thread | [optional] -**folder** | **str** | Thread folder location | [optional] +**id** |**str** |Thread identifier |[optional] +**subject** |**str** |Thread subject |[optional] +**messages** |[**list[EmailDto]**](EmailDto.md) |List of messages in thread |[optional] +**folder** |**str** |Thread folder location |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_thread = models.EmailThread( + id='5', + subject='Some subject', + messages=[ + models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + date=datetime.today(), + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]), + models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Other body', + body_type='Html', + date=datetime.today(), + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/EmailThreadList.md b/sdk/docs/EmailThreadList.md index ddfa99c..c6515d7 100644 --- a/sdk/docs/EmailThreadList.md +++ b/sdk/docs/EmailThreadList.md @@ -1,10 +1,42 @@ # AsposeEmailCloudSdk.models.EmailThreadList + +List of email threads + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfEmailThread](ListResponseOfEmailThread.md) +Parent class: [ListResponseOfEmailThread](ListResponseOfEmailThread.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +email_thread_list = models.EmailThreadList( + value=[ + models.EmailThread( + id='123', + subject='Some email subject', + messages=[ + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='1', + subject='Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')]), + models.EmailDto( + date=datetime.today(), + _from=models.MailAddress( + address='from@aspose.com'), + message_id='3', + subject='Re: Some email subject', + to=[ + models.MailAddress( + address='to@aspose.com')])])]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md b/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md index 7295f97..147f04a 100644 --- a/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md +++ b/sdk/docs/EnumWithCustomOfAssociatedPersonCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfAssociatedPersonCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Associated person's category. Enum, available values: Spouse, Child, Mother, Father, Parent, Brother, Sister, Friend, Relative, Manager, Assistant, ReferredBy, Partner, DomesticPartner, Custom | -**description** | **str** | | [optional] +**value** |**str** |Associated person's category. Enum, available values: Spouse, Child, Mother, Father, Parent, Brother, Sister, Friend, Relative, Manager, Assistant, ReferredBy, Partner, DomesticPartner, Custom | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfEmailAddressCategory.md b/sdk/docs/EnumWithCustomOfEmailAddressCategory.md index 38dcfe0..cf0c040 100644 --- a/sdk/docs/EnumWithCustomOfEmailAddressCategory.md +++ b/sdk/docs/EnumWithCustomOfEmailAddressCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfEmailAddressCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Represents category for an email address. Enum, available values: Home, Work, Custom, Email1, Email2, Email3 | -**description** | **str** | | [optional] +**value** |**str** |Represents category for an email address. Enum, available values: Home, Work, Custom, Email1, Email2, Email3 | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfEventCategory.md b/sdk/docs/EnumWithCustomOfEventCategory.md index bf22230..e50496e 100644 --- a/sdk/docs/EnumWithCustomOfEventCategory.md +++ b/sdk/docs/EnumWithCustomOfEventCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfEventCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Event category. Enum, available values: Custom, Birthday, Anniversary | -**description** | **str** | | [optional] +**value** |**str** |Event category. Enum, available values: Custom, Birthday, Anniversary | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md b/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md index e434653..873f20d 100644 --- a/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md +++ b/sdk/docs/EnumWithCustomOfInstantMessengerCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfInstantMessengerCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Instant messenger address category. Enum, available values: GoogleTalk, Aim, Yahoo, Skype, Qq, Msn, Icq, Jabber, Custom, ImAddress1, ImAddress2, ImAddress3 | -**description** | **str** | | [optional] +**value** |**str** |Instant messenger address category. Enum, available values: GoogleTalk, Aim, Yahoo, Skype, Qq, Msn, Icq, Jabber, Custom, ImAddress1, ImAddress2, ImAddress3 | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md b/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md index 0e2d77c..05e472c 100644 --- a/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md +++ b/sdk/docs/EnumWithCustomOfPhoneNumberCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfPhoneNumberCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Phone number category. Enum, available values: Custom, Home, Work, Office, Mobile, Fax, HomeFax, WorkFax, Pager, Car, Isdn, Telex, Callback, Radio, Company, TtyTdd, Assistant, Primary | -**description** | **str** | | [optional] +**value** |**str** |Phone number category. Enum, available values: Custom, Home, Work, Office, Mobile, Fax, HomeFax, WorkFax, Pager, Car, Isdn, Telex, Callback, Radio, Company, TtyTdd, Assistant, Primary | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfPostalAddressCategory.md b/sdk/docs/EnumWithCustomOfPostalAddressCategory.md index 53c44e2..ebb4c12 100644 --- a/sdk/docs/EnumWithCustomOfPostalAddressCategory.md +++ b/sdk/docs/EnumWithCustomOfPostalAddressCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfPostalAddressCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Address category. Enum, available values: Home, Work, Custom | -**description** | **str** | | [optional] +**value** |**str** |Address category. Enum, available values: Home, Work, Custom | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/EnumWithCustomOfUrlCategory.md b/sdk/docs/EnumWithCustomOfUrlCategory.md index 622c093..b594625 100644 --- a/sdk/docs/EnumWithCustomOfUrlCategory.md +++ b/sdk/docs/EnumWithCustomOfUrlCategory.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.EnumWithCustomOfUrlCategory + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Url category. Enum, available values: Profile, HomePage, Home, Work, Blog, Ftp, Custom | -**description** | **str** | | [optional] +**value** |**str** |Url category. Enum, available values: Profile, HomePage, Home, Work, Blog, Ftp, Custom | +**description** |**str** | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/Error.md b/sdk/docs/Error.md index 14b3763..5254b29 100644 --- a/sdk/docs/Error.md +++ b/sdk/docs/Error.md @@ -1,14 +1,17 @@ # AsposeEmailCloudSdk.models.Error + +Error + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **str** | Code | [optional] -**message** | **str** | Message | [optional] -**description** | **str** | Description | [optional] -**inner_error** | [**ErrorDetails**](ErrorDetails.md) | Inner Error | [optional] +**code** |**str** |Code |[optional] +**message** |**str** |Message |[optional] +**description** |**str** |Description |[optional] +**inner_error** |[**ErrorDetails**](ErrorDetails.md) |Inner Error |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ErrorDetails.md b/sdk/docs/ErrorDetails.md index bd0524f..2bfcbde 100644 --- a/sdk/docs/ErrorDetails.md +++ b/sdk/docs/ErrorDetails.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.ErrorDetails + +The error details + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**request_id** | **str** | The request id | [optional] -**_date** | **datetime** | Date | +**request_id** |**str** |The request id |[optional] +**_date** |**datetime** |Date | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/FileApi.md b/sdk/docs/FileApi.md index 8244d76..6a74c47 100644 --- a/sdk/docs/FileApi.md +++ b/sdk/docs/FileApi.md @@ -1,156 +1,289 @@ -# AsposeEmailCloudSdk.FileApi +# AsposeEmailCloudSdk.FileApi (EmailCloud.cloud_storage.file) + +File operations controller - -# copy_file +## copy_file + +Description: Copy file +Method call example: ```python -copy_file(self, request: CopyFileRequest) +api.cloud_storage.file.copy_file(request) ``` -Copy file +### Parameter: request -### Return type +Description: copy_file method request. -None +See parameter model documentation at [CopyFileRequest](CopyFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -CopyFileRequest( - src_path, - dest_path, - src_storage_name, - dest_storage_name, - version_id) +request = models.CopyFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **src_path** | **str** | Source file path e.g. '/folder/file.ext' | - **dest_path** | **str** | Destination file path | - **src_storage_name** | **str** | Source storage name | [optional] - **dest_storage_name** | **str** | Destination storage name | [optional] - **version_id** | **str** | File version ID to copy | [optional] +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CopyFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') + +// Call method: +api.cloud_storage.file.copy_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# delete_file +## delete_file + +Description: Delete file +Method call example: ```python -delete_file(self, request: DeleteFileRequest) +api.cloud_storage.file.delete_file(request) ``` -Delete file +### Parameter: request -### Return type +Description: delete_file method request. -None +See parameter model documentation at [DeleteFileRequest](DeleteFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -DeleteFileRequest( - path, - storage_name, - version_id) +request = models.DeleteFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | File path e.g. '/folder/file.ext' | - **storage_name** | **str** | Storage name | [optional] - **version_id** | **str** | File version ID to delete | [optional] +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.DeleteFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') + +// Call method: +api.cloud_storage.file.delete_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# download_file +## download_file + +Description: Download file + +Returns: The raw data of the file. +Method call example: ```python -download_file(self, request: DownloadFileRequest) +result = api.cloud_storage.file.download_file(request) ``` -Download file +### Parameter: request -### Return type +Description: download_file method request. -str +See parameter model documentation at [DownloadFileRequest](DownloadFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -DownloadFileRequest( - path, - storage_name, - version_id) +request = models.DownloadFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | File path e.g. '/folder/file.ext' | - **storage_name** | **str** | Storage name | [optional] - **version_id** | **str** | File version ID to download | [optional] +
+ +### Result + +Description: The raw data of the file. + +Return type: **Stream** + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.DownloadFileRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.file.download_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# move_file +## move_file + +Description: Move file + +Method call example: +```python +api.cloud_storage.file.move_file(request) +``` + +### Parameter: request +Description: move_file method request. + +See parameter model documentation at [MoveFileRequest](MoveFileRequest.md). + +
+ Parameter initialization example: + ```python -move_file(self, request: MoveFileRequest) +request = models.MoveFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') ``` -Move file +
+ +### Result + +Return type: void (empty response body) -### Return type +### Complete example -None +
+ Method call example: -### request Parameter ```python -MoveFileRequest( - src_path, - dest_path, - src_storage_name, - dest_storage_name, - version_id) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MoveFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') + +// Call method: +api.cloud_storage.file.move_file(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **src_path** | **str** | Source file path e.g. '/src.ext' | - **dest_path** | **str** | Destination file path e.g. '/dest.ext' | - **src_storage_name** | **str** | Source storage name | [optional] - **dest_storage_name** | **str** | Destination storage name | [optional] - **version_id** | **str** | File version ID to move | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# upload_file +## upload_file + +Description: Upload file + +Returns: Empty error list if the upload is successful. +Method call example: ```python -upload_file(self, request: UploadFileRequest) +result = api.cloud_storage.file.upload_file(request) ``` -Upload file +### Parameter: request -### Return type +Description: upload_file method request. -FilesUploadResult +See parameter model documentation at [UploadFileRequest](UploadFileRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -UploadFileRequest( - path, - file, - storage_name) +request = models.UploadFileRequest( + path='/storage/path/to/file.ext', + file='/local/file/system/path/to/file.ext', + storage_name='First Storage') +``` + +
+ +### Result + +Description: Empty error list if the upload is successful. + +Return type: [**FilesUploadResult**](FilesUploadResult.md) + +
+ Result example + +```python +result = +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.UploadFileRequest( + path='/storage/path/to/file.ext', + file='/local/file/system/path/to/file.ext', + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.file.upload_file(request) + +// Result example: +result = ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | 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. | - **file** | **str** | File to upload | - **storage_name** | **str** | Storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/FileApi_list.md b/sdk/docs/FileApi_list.md index 2e5ba59..134ec67 100644 --- a/sdk/docs/FileApi_list.md +++ b/sdk/docs/FileApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for FileApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/FileVersion.md b/sdk/docs/FileVersion.md index 33cad68..0a212e0 100644 --- a/sdk/docs/FileVersion.md +++ b/sdk/docs/FileVersion.md @@ -1,12 +1,16 @@ # AsposeEmailCloudSdk.models.FileVersion + +File Version + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**version_id** | **str** | File Version ID. | [optional] -**is_latest** | **bool** | Specifies whether the file is (true) or is not (false) the latest version of an file. | +**version_id** |**str** |File Version ID. |[optional] +**is_latest** |**bool** |Specifies whether the file is (true) or is not (false) the latest version of an file. | - Parent class: [StorageFile](StorageFile.md) +Parent class: [StorageFile](StorageFile.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/FileVersions.md b/sdk/docs/FileVersions.md index 2155024..7b2ae56 100644 --- a/sdk/docs/FileVersions.md +++ b/sdk/docs/FileVersions.md @@ -1,11 +1,27 @@ # AsposeEmailCloudSdk.models.FileVersions + +File versions FileVersion. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[FileVersion]**](FileVersion.md) | File versions FileVersion. | [optional] +**value** |[**list[FileVersion]**](FileVersion.md) |File versions FileVersion. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +file_versions = models.FileVersions( + value=[ + models.FileVersion( + version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', + is_latest=True, + name='file.ext', + modified_date=datetime.today(), + size=4096, + path='/storage/path/to')]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/FilesList.md b/sdk/docs/FilesList.md index e306967..41b9188 100644 --- a/sdk/docs/FilesList.md +++ b/sdk/docs/FilesList.md @@ -1,11 +1,25 @@ # AsposeEmailCloudSdk.models.FilesList + +Files list + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[StorageFile]**](StorageFile.md) | Files and folders contained by folder StorageFile. | [optional] +**value** |[**list[StorageFile]**](StorageFile.md) |Files and folders contained by folder StorageFile. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +files_list = models.FilesList( + value=[ + models.StorageFile( + name='file.ext', + modified_date=datetime.today(), + size=1024, + path='/path/to/file/on/storage')]) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/FilesUploadResult.md b/sdk/docs/FilesUploadResult.md index 64c161a..6ec4913 100644 --- a/sdk/docs/FilesUploadResult.md +++ b/sdk/docs/FilesUploadResult.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.FilesUploadResult + +File upload result + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uploaded** | **list[str]** | List of uploaded file names | [optional] -**errors** | [**list[Error]**](Error.md) | List of errors. | [optional] +**uploaded** |**list[str]** |List of uploaded file names |[optional] +**errors** |[**list[Error]**](Error.md) |List of errors. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/FolderApi.md b/sdk/docs/FolderApi.md index bbb8d2c..2038121 100644 --- a/sdk/docs/FolderApi.md +++ b/sdk/docs/FolderApi.md @@ -1,148 +1,297 @@ -# AsposeEmailCloudSdk.FolderApi +# AsposeEmailCloudSdk.FolderApi (EmailCloud.cloud_storage.folder) + +Folder operations controller - -# copy_folder +## copy_folder + +Description: Copy folder +Method call example: ```python -copy_folder(self, request: CopyFolderRequest) +api.cloud_storage.folder.copy_folder(request) ``` -Copy folder +### Parameter: request -### Return type +Description: copy_folder method request. -None +See parameter model documentation at [CopyFolderRequest](CopyFolderRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -CopyFolderRequest( - src_path, - dest_path, - src_storage_name, - dest_storage_name) +request = models.CopyFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **src_path** | **str** | Source folder path e.g. '/src' | - **dest_path** | **str** | Destination folder path e.g. '/dst' | - **src_storage_name** | **str** | Source storage name | [optional] - **dest_storage_name** | **str** | Destination storage name | [optional] +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CopyFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') + +// Call method: +api.cloud_storage.folder.copy_folder(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# create_folder +## create_folder + +Description: Create the folder + +Method call example: +```python +api.cloud_storage.folder.create_folder(request) +``` + +### Parameter: request + +Description: create_folder method request. + +See parameter model documentation at [CreateFolderRequest](CreateFolderRequest.md). +
+ Parameter initialization example: + ```python -create_folder(self, request: CreateFolderRequest) +request = models.CreateFolderRequest( + path='/storage/path/to/new/folder', + storage_name='First Storage') ``` -Create the folder +
-### Return type +### Result -None +Return type: void (empty response body) + +### Complete example + +
+ Method call example: -### request Parameter ```python -CreateFolderRequest( - path, - storage_name) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.CreateFolderRequest( + path='/storage/path/to/new/folder', + storage_name='First Storage') + +// Call method: +api.cloud_storage.folder.create_folder(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | Folder path to create e.g. 'folder_1/folder_2/' | - **storage_name** | **str** | Storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# delete_folder +## delete_folder + +Description: Delete folder + +Method call example: +```python +api.cloud_storage.folder.delete_folder(request) +``` + +### Parameter: request + +Description: delete_folder method request. + +See parameter model documentation at [DeleteFolderRequest](DeleteFolderRequest.md). +
+ Parameter initialization example: + ```python -delete_folder(self, request: DeleteFolderRequest) +request = models.DeleteFolderRequest( + path='/storage/path/to/folder', + storage_name='First Storage', + recursive=True) ``` -Delete folder +
-### Return type +### Result -None +Return type: void (empty response body) + +### Complete example + +
+ Method call example: -### request Parameter ```python -DeleteFolderRequest( - path, - storage_name, - recursive) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.DeleteFolderRequest( + path='/storage/path/to/folder', + storage_name='First Storage', + recursive=True) + +// Call method: +api.cloud_storage.folder.delete_folder(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | Folder path e.g. '/folder' | - **storage_name** | **str** | Storage name | [optional] - **recursive** | **bool** | Enable to delete folders, subfolders and files | [optional] [default to false] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_files_list +## get_files_list +Description: Get all files and folders within a folder + +Returns: Returns all files and folders contained by the folder. + +Method call example: ```python -get_files_list(self, request: GetFilesListRequest) +result = api.cloud_storage.folder.get_files_list(request) ``` -Get all files and folders within a folder +### Parameter: request + +Description: get_files_list method request. + +See parameter model documentation at [GetFilesListRequest](GetFilesListRequest.md). + +
+ Parameter initialization example: + +```python +request = models.GetFilesListRequest( + path='/storage/path/to/folder', + storage_name='First Storage') +``` + +
+ +### Result + +Description: Returns all files and folders contained by the folder. + +Return type: [**FilesList**](FilesList.md) -### Return type +
+ Result example -FilesList +```python +result = models.FilesList( + value=[ + models.StorageFile( + name='file.ext', + modified_date=datetime.today(), + size=1024, + path='/path/to/file/on/storage')]) +``` +
+ +### Complete example + +
+ Method call example: -### request Parameter ```python -GetFilesListRequest( - path, - storage_name) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.GetFilesListRequest( + path='/storage/path/to/folder', + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.folder.get_files_list(request) + +// Result example: +result = models.FilesList( + value=[ + models.StorageFile( + name='file.ext', + modified_date=datetime.today(), + size=1024, + path='/path/to/file/on/storage')]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | Folder path e.g. '/folder' | - **storage_name** | **str** | Storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# move_folder +## move_folder +Description: Move folder + +Method call example: ```python -move_folder(self, request: MoveFolderRequest) +api.cloud_storage.folder.move_folder(request) ``` -Move folder +### Parameter: request -### Return type +Description: move_folder method request. -None +See parameter model documentation at [MoveFolderRequest](MoveFolderRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -MoveFolderRequest( - src_path, - dest_path, - src_storage_name, - dest_storage_name) +request = models.MoveFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') +``` + +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MoveFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') + +// Call method: +api.cloud_storage.folder.move_folder(request) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **src_path** | **str** | Folder path to move e.g. '/folder' | - **dest_path** | **str** | Destination folder path to move to e.g '/dst' | - **src_storage_name** | **str** | Source storage name | [optional] - **dest_storage_name** | **str** | Destination storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/FolderApi_list.md b/sdk/docs/FolderApi_list.md index 942da5b..e92a481 100644 --- a/sdk/docs/FolderApi_list.md +++ b/sdk/docs/FolderApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for FolderApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/GetDiscUsageRequest.md b/sdk/docs/GetDiscUsageRequest.md new file mode 100644 index 0000000..060dfa5 --- /dev/null +++ b/sdk/docs/GetDiscUsageRequest.md @@ -0,0 +1,15 @@ +# GetDiscUsageRequest + +Request model for StorageApi.get_disc_usage + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**storage_name** |**str** |Storage name |[optional] + +## Example +```python +request = models.GetDiscUsageRequest( + storage_name='First Storage') +``` diff --git a/sdk/docs/GetFileVersionsRequest.md b/sdk/docs/GetFileVersionsRequest.md new file mode 100644 index 0000000..01b2dc0 --- /dev/null +++ b/sdk/docs/GetFileVersionsRequest.md @@ -0,0 +1,17 @@ +# GetFileVersionsRequest + +Request model for StorageApi.get_file_versions + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |File path e.g. '/file.ext' | +**storage_name** |**str** |Storage name |[optional] + +## Example +```python +request = models.GetFileVersionsRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') +``` diff --git a/sdk/docs/GetFilesListRequest.md b/sdk/docs/GetFilesListRequest.md new file mode 100644 index 0000000..78045d5 --- /dev/null +++ b/sdk/docs/GetFilesListRequest.md @@ -0,0 +1,17 @@ +# GetFilesListRequest + +Request model for FolderApi.get_files_list + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |Folder path e.g. '/folder' | +**storage_name** |**str** |Storage name |[optional] + +## Example +```python +request = models.GetFilesListRequest( + path='/storage/path/to/folder', + storage_name='First Storage') +``` diff --git a/sdk/docs/InstantMessengerAddress.md b/sdk/docs/InstantMessengerAddress.md index 23b740b..2ba078d 100644 --- a/sdk/docs/InstantMessengerAddress.md +++ b/sdk/docs/InstantMessengerAddress.md @@ -1,13 +1,16 @@ # AsposeEmailCloudSdk.models.InstantMessengerAddress + +Instant messenger address. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [**EnumWithCustomOfInstantMessengerCategory**](EnumWithCustomOfInstantMessengerCategory.md) | Address category. | [optional] -**address** | **str** | Address. | [optional] -**preferred** | **bool** | Determines whether this address is preferred. | +**category** |[**EnumWithCustomOfInstantMessengerCategory**](EnumWithCustomOfInstantMessengerCategory.md) |Address category. |[optional] +**address** |**str** |Address. |[optional] +**preferred** |**bool** |Determines whether this address is preferred. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/LinkedResource.md b/sdk/docs/LinkedResource.md index ee3f1de..4585d4f 100644 --- a/sdk/docs/LinkedResource.md +++ b/sdk/docs/LinkedResource.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.LinkedResource + +Represents an embedded resource in a message. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content_link** | **str** | URI that the resource must match. | [optional] +**content_link** |**str** |URI that the resource must match. |[optional] - Parent class: [AttachmentBase](AttachmentBase.md) +Parent class: [AttachmentBase](AttachmentBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ListResponseOfAiNameComponent.md b/sdk/docs/ListResponseOfAiNameComponent.md index 43d5c39..f7461e8 100644 --- a/sdk/docs/ListResponseOfAiNameComponent.md +++ b/sdk/docs/ListResponseOfAiNameComponent.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfAiNameComponent + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[AiNameComponent]**](AiNameComponent.md) | | [optional] +**value** |[**list[AiNameComponent]**](AiNameComponent.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfAiNameExtracted.md b/sdk/docs/ListResponseOfAiNameExtracted.md index 9a14381..663a65b 100644 --- a/sdk/docs/ListResponseOfAiNameExtracted.md +++ b/sdk/docs/ListResponseOfAiNameExtracted.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfAiNameExtracted + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[AiNameExtracted]**](AiNameExtracted.md) | | [optional] +**value** |[**list[AiNameExtracted]**](AiNameExtracted.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfAiNameGenderHypothesis.md b/sdk/docs/ListResponseOfAiNameGenderHypothesis.md index 8286c32..5599123 100644 --- a/sdk/docs/ListResponseOfAiNameGenderHypothesis.md +++ b/sdk/docs/ListResponseOfAiNameGenderHypothesis.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfAiNameGenderHypothesis + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[AiNameGenderHypothesis]**](AiNameGenderHypothesis.md) | | [optional] +**value** |[**list[AiNameGenderHypothesis]**](AiNameGenderHypothesis.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfContactDto.md b/sdk/docs/ListResponseOfContactDto.md index 528716f..06ddb5c 100644 --- a/sdk/docs/ListResponseOfContactDto.md +++ b/sdk/docs/ListResponseOfContactDto.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfContactDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[ContactDto]**](ContactDto.md) | | [optional] +**value** |[**list[ContactDto]**](ContactDto.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfEmailAccountConfig.md b/sdk/docs/ListResponseOfEmailAccountConfig.md index 6995300..cde21df 100644 --- a/sdk/docs/ListResponseOfEmailAccountConfig.md +++ b/sdk/docs/ListResponseOfEmailAccountConfig.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfEmailAccountConfig + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[EmailAccountConfig]**](EmailAccountConfig.md) | | [optional] +**value** |[**list[EmailAccountConfig]**](EmailAccountConfig.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfEmailDto.md b/sdk/docs/ListResponseOfEmailDto.md index 160735d..67af3ae 100644 --- a/sdk/docs/ListResponseOfEmailDto.md +++ b/sdk/docs/ListResponseOfEmailDto.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfEmailDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[EmailDto]**](EmailDto.md) | | [optional] +**value** |[**list[EmailDto]**](EmailDto.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfEmailThread.md b/sdk/docs/ListResponseOfEmailThread.md index 9aacdd3..60a14ad 100644 --- a/sdk/docs/ListResponseOfEmailThread.md +++ b/sdk/docs/ListResponseOfEmailThread.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfEmailThread + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[EmailThread]**](EmailThread.md) | | [optional] +**value** |[**list[EmailThread]**](EmailThread.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfMailMessageBase.md b/sdk/docs/ListResponseOfMailMessageBase.md index 0e7e190..cf2bd24 100644 --- a/sdk/docs/ListResponseOfMailMessageBase.md +++ b/sdk/docs/ListResponseOfMailMessageBase.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfMailMessageBase + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[MailMessageBase]**](MailMessageBase.md) | | [optional] +**value** |[**list[MailMessageBase]**](MailMessageBase.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfMailServerFolder.md b/sdk/docs/ListResponseOfMailServerFolder.md index b5e4c13..d0f9aa9 100644 --- a/sdk/docs/ListResponseOfMailServerFolder.md +++ b/sdk/docs/ListResponseOfMailServerFolder.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfMailServerFolder + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[MailServerFolder]**](MailServerFolder.md) | | [optional] +**value** |[**list[MailServerFolder]**](MailServerFolder.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfStorageFileLocation.md b/sdk/docs/ListResponseOfStorageFileLocation.md index 0929da2..275a834 100644 --- a/sdk/docs/ListResponseOfStorageFileLocation.md +++ b/sdk/docs/ListResponseOfStorageFileLocation.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfStorageFileLocation + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[StorageFileLocation]**](StorageFileLocation.md) | | [optional] +**value** |[**list[StorageFileLocation]**](StorageFileLocation.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md b/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md index cd24561..3df2aed 100644 --- a/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md +++ b/sdk/docs/ListResponseOfStorageModelOfCalendarDto.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfCalendarDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[StorageModelOfCalendarDto]**](StorageModelOfCalendarDto.md) | | [optional] +**value** |[**list[StorageModelOfCalendarDto]**](StorageModelOfCalendarDto.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfStorageModelOfContactDto.md b/sdk/docs/ListResponseOfStorageModelOfContactDto.md index 442ebe5..0e28f20 100644 --- a/sdk/docs/ListResponseOfStorageModelOfContactDto.md +++ b/sdk/docs/ListResponseOfStorageModelOfContactDto.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfContactDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[StorageModelOfContactDto]**](StorageModelOfContactDto.md) | | [optional] +**value** |[**list[StorageModelOfContactDto]**](StorageModelOfContactDto.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ListResponseOfStorageModelOfEmailDto.md b/sdk/docs/ListResponseOfStorageModelOfEmailDto.md index 9182970..772288c 100644 --- a/sdk/docs/ListResponseOfStorageModelOfEmailDto.md +++ b/sdk/docs/ListResponseOfStorageModelOfEmailDto.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfEmailDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**list[StorageModelOfEmailDto]**](StorageModelOfEmailDto.md) | | [optional] +**value** |[**list[StorageModelOfEmailDto]**](StorageModelOfEmailDto.md) | |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailAddress.md b/sdk/docs/MailAddress.md index 5ff0c36..e798961 100644 --- a/sdk/docs/MailAddress.md +++ b/sdk/docs/MailAddress.md @@ -1,14 +1,17 @@ # AsposeEmailCloudSdk.models.MailAddress + +Represents the address of a message. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**display_name** | **str** | Display name | [optional] -**address** | **str** | Address | [optional] -**participation_status** | **str** | Identifies the participation status for the calendar user. Enum, available values: NeedsAction, Accepted, Declined, Tentative, Delegated | -**original_address_string** | **str** | The original e-mail address string | [optional] +**display_name** |**str** |Display name |[optional] +**address** |**str** |Address |[optional] +**participation_status** |**str** |Identifies the participation status for the calendar user. Enum, available values: NeedsAction, Accepted, Declined, Tentative, Delegated | +**original_address_string** |**str** |The original e-mail address string |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailMessageBase.md b/sdk/docs/MailMessageBase.md index 0419d53..09dc179 100644 --- a/sdk/docs/MailMessageBase.md +++ b/sdk/docs/MailMessageBase.md @@ -1,11 +1,20 @@ # AsposeEmailCloudSdk.models.MailMessageBase + +Universal object that stores email messages in different formats. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**discriminator** | **str** | | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mail_message_base = models.MailMessageBase( + ) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MailMessageBase64.md b/sdk/docs/MailMessageBase64.md index 8c151ae..7cc028e 100644 --- a/sdk/docs/MailMessageBase64.md +++ b/sdk/docs/MailMessageBase64.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.MailMessageBase64 + +Email message represented as file, encoded to Base64 format. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value_base64** | **str** | Email message file data encoded to Base64 string. | -**format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**value_base64** |**str** |Email message file data encoded to Base64 string. | +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - Parent class: [MailMessageBase](MailMessageBase.md) +Parent class: [MailMessageBase](MailMessageBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mail_message_base64 = models.MailMessageBase64( + value_base64='RnJvbTogZkBmLnVzClRvOiB0QHQudXMKU3ViamVjdDogUwoKQm9keQ==') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailMessageBaseList.md b/sdk/docs/MailMessageBaseList.md index c03810b..a2dd630 100644 --- a/sdk/docs/MailMessageBaseList.md +++ b/sdk/docs/MailMessageBaseList.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.MailMessageBaseList + +List of messages. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) +Parent class: [ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MailMessageDto.md b/sdk/docs/MailMessageDto.md index ae283c7..3184e50 100644 --- a/sdk/docs/MailMessageDto.md +++ b/sdk/docs/MailMessageDto.md @@ -1,11 +1,41 @@ # AsposeEmailCloudSdk.models.MailMessageDto + +Represents email message, stored as an EmailDto object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**EmailDto**](EmailDto.md) | Message document object. | +**value** |[**EmailDto**](EmailDto.md) |Message document object. | - Parent class: [MailMessageBase](MailMessageBase.md) +Parent class: [MailMessageBase](MailMessageBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mail_message_dto = models.MailMessageDto( + value=models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')])) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailMessageMapi.md b/sdk/docs/MailMessageMapi.md index cbc1fa8..113c2aa 100644 --- a/sdk/docs/MailMessageMapi.md +++ b/sdk/docs/MailMessageMapi.md @@ -1,11 +1,48 @@ # AsposeEmailCloudSdk.models.MailMessageMapi + +Email message represented as MAPI object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | [**MapiMessageDto**](MapiMessageDto.md) | Email message object. | +**value** |[**MapiMessageDto**](MapiMessageDto.md) |Email message object. | - Parent class: [MailMessageBase](MailMessageBase.md) +Parent class: [MailMessageBase](MailMessageBase.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mail_message_mapi = models.MailMessageMapi( + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailServerFolder.md b/sdk/docs/MailServerFolder.md index 3cc961e..ea9cf28 100644 --- a/sdk/docs/MailServerFolder.md +++ b/sdk/docs/MailServerFolder.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.MailServerFolder + +Email account folder + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Gets or sets mail folder name | [optional] -**id** | **str** | Gets or sets mail folder id | [optional] +**name** |**str** |Gets or sets mail folder name |[optional] +**id** |**str** |Gets or sets mail folder id |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MailServerFolderList.md b/sdk/docs/MailServerFolderList.md index f1e10bd..bf5f11c 100644 --- a/sdk/docs/MailServerFolderList.md +++ b/sdk/docs/MailServerFolderList.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.MailServerFolderList + +List of email client folders. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) +Parent class: [ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiAttachmentDto.md b/sdk/docs/MapiAttachmentDto.md index c1a866a..a4f417a 100644 --- a/sdk/docs/MapiAttachmentDto.md +++ b/sdk/docs/MapiAttachmentDto.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.MapiAttachmentDto + +Mapi attachment + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Attachment's name | [optional] -**data_base64** | **str** | Attachment data represented as Base64 string. | [optional] +**name** |**str** |Attachment's name |[optional] +**data_base64** |**str** |Attachment data represented as Base64 string. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_attachment_dto = models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiBinaryPropertyDto.md b/sdk/docs/MapiBinaryPropertyDto.md index 548f194..26f9ecd 100644 --- a/sdk/docs/MapiBinaryPropertyDto.md +++ b/sdk/docs/MapiBinaryPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiBinaryPropertyDto + +Mapi property with Binary value represented as a Base64 string + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value_base64** | **str** | Property value converted to Base64 | [optional] +**value_base64** |**str** |Property value converted to Base64 |[optional] - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiBooleanPropertyDto.md b/sdk/docs/MapiBooleanPropertyDto.md index 1c15750..9d505a3 100644 --- a/sdk/docs/MapiBooleanPropertyDto.md +++ b/sdk/docs/MapiBooleanPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiBooleanPropertyDto + +Mapi property with Boolean value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **bool** | Property value | +**value** |**bool** |Property value | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiCalendarApi.md b/sdk/docs/MapiCalendarApi.md index 718c98a..879fa5b 100644 --- a/sdk/docs/MapiCalendarApi.md +++ b/sdk/docs/MapiCalendarApi.md @@ -1,114 +1,617 @@ -# AsposeEmailCloudSdk.MapiCalendarApi +# AsposeEmailCloudSdk.MapiCalendarApi (EmailCloud.mapi.calendar) + +MAPI calendar operations. - -# as_calendar_dto +## as_calendar_dto + +Description: Converts MAPI calendar model to CalendarDto model. + +Returns: CalendarDto model. +Method call example: ```python -as_calendar_dto(self, MapiCalendarDto mapi_calendar_dto) +result = api.mapi.calendar.as_calendar_dto(mapi_calendar_dto) ``` -Converts MAPI calendar model to CalendarDto model. +### Parameter: mapi_calendar_dto + +Description: MAPI calendar model to convert. + +See parameter model documentation at [MapiCalendarDto](MapiCalendarDto.md) -### Return type +
+ Parameter initialization example: + +```python +mapi_calendar_dto = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` -[**CalendarDto**](CalendarDto.md) +
-### mapi_calendar_dto Parameter +### Result -See parameter model documentation at [MapiCalendarDto](MapiCalendarDto.md) +Description: CalendarDto model. + +Return type: [**CalendarDto**](CalendarDto.md) + +
+ Result example + +```python +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +mapi_calendar_dto = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') + +// Call method: +result = api.mapi.calendar.as_calendar_dto(mapi_calendar_dto) + +// Result example: +result = models.CalendarDto( + attendees=[ + models.MailAddress( + display_name='Attendee Name', + address='attendee@aspose.com', + participation_status='Accepted')], + description='Some description', + end_date=datetime.today(), + location='Some location', + organizer=models.MailAddress( + display_name='Organizer Name', + address='organizer@aspose.com'), + recurrence=models.DailyRecurrencePatternDto( + interval=-1, + occurs=10, + week_start='Monday'), + start_date=datetime.today(), + summary='Some summary') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_file +## as_file +Description: Converts MAPI calendar model to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.mapi.calendar.as_file(request) +``` + +### Parameter: request + +Description: MAPI calendar model to convert. + +See parameter model documentation at [MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) + +
+ Parameter initialization example: + ```python -as_file(self, MapiCalendarAsFileRequest request) +request = models.MapiCalendarAsFileRequest( + format='Msg', + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) ``` -Converts MAPI calendar model to specified format and returns as file. +
-### Return type +### Result -**Stream** +Description: File stream in specified format. -### request Parameter +Return type: **Stream** -See parameter model documentation at [MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiCalendarAsFileRequest( + format='Msg', + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) + +// Call method: +result = api.mapi.calendar.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts calendar file to a MAPI model representation. + +Returns: MAPI model. + +Method call example: +```python +result = api.mapi.calendar.from_file(request) +``` + +### Parameter: request + +Description: from_file method request. +See parameter model documentation at [MapiCalendarFromFileRequest](MapiCalendarFromFileRequest.md). + +
+ Parameter initialization example: + ```python -from_file(self, request: MapiCalendarFromFileRequest) +request = models.MapiCalendarFromFileRequest( + file='/path/to/calendar.msg') ``` -Converts calendar file to a MAPI model representation. +
+ +### Result + +Description: MAPI model. + +Return type: [**MapiCalendarDto**](MapiCalendarDto.md) + +
+ Result example + +```python +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` +
-### Return type +### Complete example -MapiCalendarDto +
+ Method call example: -### request Parameter ```python -MapiCalendarFromFileRequest( - file) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiCalendarFromFileRequest( + file='/path/to/calendar.msg') + +// Call method: +result = api.mapi.calendar.from_file(request) + +// Result example: +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **str** | File to convert | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get + +Description: Get MAPI calendar document. + +Returns: MAPI Calendar model. +Method call example: ```python -get(self, request: MapiCalendarGetRequest) +result = api.mapi.calendar.get(request) ``` -Get MAPI calendar document. +### Parameter: request -### Return type +Description: get method request. -MapiCalendarDto +See parameter model documentation at [MapiCalendarGetRequest](MapiCalendarGetRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -MapiCalendarGetRequest( - file_name, - folder, - storage) +request = models.MapiCalendarGetRequest( + file_name='calendar.msg', + folder='calendar/location/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_name** | **str** | Calendar file name in storage. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
+ +### Result + +Description: MAPI Calendar model. + +Return type: [**MapiCalendarDto**](MapiCalendarDto.md) + +
+ Result example + +```python +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiCalendarGetRequest( + file_name='calendar.msg', + folder='calendar/location/on/storage', + storage='First Storage') + +// Call method: +result = api.mapi.calendar.get(request) + +// Result example: +result = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save MAPI Calendar to storage. +Method call example: ```python -save(self, MapiCalendarSaveRequest request) +api.mapi.calendar.save(request) ``` -Save MAPI Calendar to storage. +### Parameter: request -### Return type +Description: Calendar create/update request. -void (empty response body) +See parameter model documentation at [MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.MapiCalendarSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='calendar.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) +``` -See parameter model documentation at [MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiCalendarSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='calendar.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) + +// Call method: +api.mapi.calendar.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarApi_list.md b/sdk/docs/MapiCalendarApi_list.md index 3de251c..ce840a7 100644 --- a/sdk/docs/MapiCalendarApi_list.md +++ b/sdk/docs/MapiCalendarApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for MapiCalendarApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/MapiCalendarAsFileRequest.md b/sdk/docs/MapiCalendarAsFileRequest.md index b40c711..c5dbccd 100644 --- a/sdk/docs/MapiCalendarAsFileRequest.md +++ b/sdk/docs/MapiCalendarAsFileRequest.md @@ -1,12 +1,49 @@ # AsposeEmailCloudSdk.models.MapiCalendarAsFileRequest + +Convert MapiCalendar to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Calendar file format Enum, available values: Ics, Msg | -**value** | [**MapiCalendarDto**](MapiCalendarDto.md) | MAPI calendar model. | +**format** |**str** |Calendar file format Enum, available values: Ics, Msg | +**value** |[**MapiCalendarDto**](MapiCalendarDto.md) |MAPI calendar model. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_calendar_as_file_request = models.MapiCalendarAsFileRequest( + format='Msg', + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiCalendarAttendeesDto.md b/sdk/docs/MapiCalendarAttendeesDto.md index c833692..3e1b0fb 100644 --- a/sdk/docs/MapiCalendarAttendeesDto.md +++ b/sdk/docs/MapiCalendarAttendeesDto.md @@ -1,14 +1,17 @@ # AsposeEmailCloudSdk.models.MapiCalendarAttendeesDto + +Mapi calendar attendees. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**appointment_recipients** | [**list[MapiRecipientDto]**](MapiRecipientDto.md) | List of attendees. | [optional] -**appointment_unsendable_recipients** | [**list[MapiRecipientDto]**](MapiRecipientDto.md) | List of unsendable attendees. | [optional] -**not_allow_propose** | **bool** | Value indicating whether attendees are not allowed to propose a new date and/or time for the meeting. | -**response_requested** | **bool** | Value indicating whether a response is requested to a Message object. | +**appointment_recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |List of attendees. |[optional] +**appointment_unsendable_recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |List of unsendable attendees. |[optional] +**not_allow_propose** |**bool** |Value indicating whether attendees are not allowed to propose a new date and/or time for the meeting. | +**response_requested** |**bool** |Value indicating whether a response is requested to a Message object. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md b/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md index f4f2527..7e779ea 100644 --- a/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md +++ b/sdk/docs/MapiCalendarDailyRecurrencePatternDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiCalendarDailyRecurrencePatternDto + +Represents the daily recurrence pattern of the mapi calendar. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**day_of_week** | **list[str]** | Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday | [optional] +**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] - Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) +Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiCalendarDto.md b/sdk/docs/MapiCalendarDto.md index 839d4e9..901f2ab 100644 --- a/sdk/docs/MapiCalendarDto.md +++ b/sdk/docs/MapiCalendarDto.md @@ -1,28 +1,64 @@ # AsposeEmailCloudSdk.models.MapiCalendarDto + +Represents the mapi calendar object + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**appointment_counter_proposal** | **bool** | Value indicating whether a Meeting Response object is a counter proposal. | -**attendees** | [**MapiCalendarAttendeesDto**](MapiCalendarAttendeesDto.md) | Attendees | [optional] -**busy_status** | **str** | Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | -**client_intent** | **list[str]** | Actions the user has taken on this Meeting object. Items: Enumerates the actions the user can taken on the Meeting object Enum, available values: Manager, Delegate, DeletedWithNoResponse, DeletedExceptionWithNoResponse, RespondedTentative, RespondedAccept, RespondedDecline, ModifiedStartTime, ModifiedEndTime, ModifiedLocation, RespondedExceptionDecline, Canceled, ExceptionCanceled | [optional] -**end_date** | **datetime** | End date and time of the event. If the date is not set, default value for DateTime is returned. | -**end_date_time_zone** | [**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) | Time zone information that indicates the time zone of the EndDate property. | [optional] -**is_all_day** | **bool** | Value indicating whether the event is an all-day event. | -**key_words** | **str** | Categories of the calendar object. | [optional] -**location** | **str** | Location of the event. | [optional] -**recurrence** | [**MapiCalendarEventRecurrenceDto**](MapiCalendarEventRecurrenceDto.md) | Recurrence properties. | [optional] -**reminder_delta** | **int** | Interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object. | -**reminder_file_parameter** | **str** | Full path of the sound that a client SHOULD play when the reminder becomes overdue. | [optional] -**reminder_set** | **bool** | Value indicating whether a reminder is set on the object. | -**sequence** | **int** | Sequence number. | -**start_date** | **datetime** | Start date and time of the event. If the date is not set, default value for DateTime is returned. | -**start_date_time_zone** | [**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) | Time zone information that indicates the time zone of the StartDate property. | [optional] -**uid** | **str** | Unique identifier. | [optional] -**organizer** | [**MapiElectronicAddressDto**](MapiElectronicAddressDto.md) | Organizer | [optional] - - Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) +**appointment_counter_proposal** |**bool** |Value indicating whether a Meeting Response object is a counter proposal. | +**attendees** |[**MapiCalendarAttendeesDto**](MapiCalendarAttendeesDto.md) |Attendees |[optional] +**busy_status** |**str** |Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | +**client_intent** |**list[str]** |Actions the user has taken on this Meeting object. Items: Enumerates the actions the user can taken on the Meeting object Enum, available values: Manager, Delegate, DeletedWithNoResponse, DeletedExceptionWithNoResponse, RespondedTentative, RespondedAccept, RespondedDecline, ModifiedStartTime, ModifiedEndTime, ModifiedLocation, RespondedExceptionDecline, Canceled, ExceptionCanceled |[optional] +**end_date** |**datetime** |End date and time of the event. If the date is not set, default value for DateTime is returned. | +**end_date_time_zone** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that indicates the time zone of the EndDate property. |[optional] +**is_all_day** |**bool** |Value indicating whether the event is an all-day event. | +**key_words** |**str** |Categories of the calendar object. |[optional] +**location** |**str** |Location of the event. |[optional] +**recurrence** |[**MapiCalendarEventRecurrenceDto**](MapiCalendarEventRecurrenceDto.md) |Recurrence properties. |[optional] +**reminder_delta** |**int** |Interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object. | +**reminder_file_parameter** |**str** |Full path of the sound that a client SHOULD play when the reminder becomes overdue. |[optional] +**reminder_set** |**bool** |Value indicating whether a reminder is set on the object. | +**sequence** |**int** |Sequence number. | +**start_date** |**datetime** |Start date and time of the event. If the date is not set, default value for DateTime is returned. | +**start_date_time_zone** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that indicates the time zone of the StartDate property. |[optional] +**uid** |**str** |Unique identifier. |[optional] +**organizer** |[**MapiElectronicAddressDto**](MapiElectronicAddressDto.md) |Organizer |[optional] + +Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_calendar_dto = models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarEventRecurrenceDto.md b/sdk/docs/MapiCalendarEventRecurrenceDto.md index e5b2e6e..00ba3e0 100644 --- a/sdk/docs/MapiCalendarEventRecurrenceDto.md +++ b/sdk/docs/MapiCalendarEventRecurrenceDto.md @@ -1,16 +1,19 @@ # AsposeEmailCloudSdk.models.MapiCalendarEventRecurrenceDto + +Recurrence properties of calendar object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**appointment_time_zone_definition_recur** | [**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) | Time zone information that describes how to convert the meeting date and time on a recurring series to and from UTC. | [optional] -**clip_end** | **datetime** | Date of the last instance. | -**clip_start** | **datetime** | Date of the first instance. | -**is_exception** | **bool** | Value indicating whether the object represents an exception. | -**recurrence_pattern** | [**MapiCalendarRecurrencePatternDto**](MapiCalendarRecurrencePatternDto.md) | Recurrence pattern. | [optional] -**time_zone_struct** | [**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) | Time zone information for a recurring meeting. | [optional] +**appointment_time_zone_definition_recur** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information that describes how to convert the meeting date and time on a recurring series to and from UTC. |[optional] +**clip_end** |**datetime** |Date of the last instance. | +**clip_start** |**datetime** |Date of the first instance. | +**is_exception** |**bool** |Value indicating whether the object represents an exception. | +**recurrence_pattern** |[**MapiCalendarRecurrencePatternDto**](MapiCalendarRecurrencePatternDto.md) |Recurrence pattern. |[optional] +**time_zone_struct** |[**MapiCalendarTimeZoneDto**](MapiCalendarTimeZoneDto.md) |Time zone information for a recurring meeting. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarExceptionInfoDto.md b/sdk/docs/MapiCalendarExceptionInfoDto.md index 9b601b5..51d4943 100644 --- a/sdk/docs/MapiCalendarExceptionInfoDto.md +++ b/sdk/docs/MapiCalendarExceptionInfoDto.md @@ -1,24 +1,27 @@ # AsposeEmailCloudSdk.models.MapiCalendarExceptionInfoDto + +An exception specifies changes to an instance of a recurring series. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attachments** | [**list[MapiAttachmentDto]**](MapiAttachmentDto.md) | Attachments in the recurrence exception. | [optional] -**body** | **str** | Body. | [optional] -**busy_status** | **str** | Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | -**end_date_time** | **datetime** | End date. | -**has_attachment** | **bool** | Value of this field specifies whether the Exception Embedded Message object contains attachments. | -**location** | **str** | Location. | [optional] -**meeting_type** | **str** | Enumerates the appointment state Enum, available values: Meeting, Received, Canceled | -**original_start_date** | **datetime** | Original start date. | -**override_flags** | **list[str]** | Override flags. Items: Specifies what data in the MapiCalendarOverride structure has a value different from the recurring series. Enum, available values: Subject, MeetingType, ReminderDelta, Reminder, Location, BusyStatus, Attachment, Subtype, AppointmentColor, ExceptionalBody | [optional] -**reminder_delta** | **int** | Reminder delta. | -**reminder_set** | **bool** | Value for the PidLidReminderSet property. | -**start_date_time** | **datetime** | Start date. | -**subject** | **str** | Subject. | [optional] -**sub_type** | **int** | SubType. | +**attachments** |[**list[MapiAttachmentDto]**](MapiAttachmentDto.md) |Attachments in the recurrence exception. |[optional] +**body** |**str** |Body. |[optional] +**busy_status** |**str** |Enumerates the mapi calendar possible busy status Enum, available values: Free, Tentative, Busy, OutOfOffice | +**end_date_time** |**datetime** |End date. | +**has_attachment** |**bool** |Value of this field specifies whether the Exception Embedded Message object contains attachments. | +**location** |**str** |Location. |[optional] +**meeting_type** |**str** |Enumerates the appointment state Enum, available values: Meeting, Received, Canceled | +**original_start_date** |**datetime** |Original start date. | +**override_flags** |**list[str]** |Override flags. Items: Specifies what data in the MapiCalendarOverride structure has a value different from the recurring series. Enum, available values: Subject, MeetingType, ReminderDelta, Reminder, Location, BusyStatus, Attachment, Subtype, AppointmentColor, ExceptionalBody |[optional] +**reminder_delta** |**int** |Reminder delta. | +**reminder_set** |**bool** |Value for the PidLidReminderSet property. | +**start_date_time** |**datetime** |Start date. | +**subject** |**str** |Subject. |[optional] +**sub_type** |**int** |SubType. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarFromFileRequest.md b/sdk/docs/MapiCalendarFromFileRequest.md new file mode 100644 index 0000000..d02d228 --- /dev/null +++ b/sdk/docs/MapiCalendarFromFileRequest.md @@ -0,0 +1,15 @@ +# MapiCalendarFromFileRequest + +Request model for MapiCalendarApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file** |**str** |File to convert | + +## Example +```python +request = models.MapiCalendarFromFileRequest( + file='/path/to/calendar.msg') +``` diff --git a/sdk/docs/MapiCalendarGetRequest.md b/sdk/docs/MapiCalendarGetRequest.md new file mode 100644 index 0000000..dd1a32f --- /dev/null +++ b/sdk/docs/MapiCalendarGetRequest.md @@ -0,0 +1,19 @@ +# MapiCalendarGetRequest + +Request model for MapiCalendarApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**file_name** |**str** |Calendar file name in storage. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.MapiCalendarGetRequest( + file_name='calendar.msg', + folder='calendar/location/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/MapiCalendarRecurrencePatternDto.md b/sdk/docs/MapiCalendarRecurrencePatternDto.md index c426931..b9c1ba3 100644 --- a/sdk/docs/MapiCalendarRecurrencePatternDto.md +++ b/sdk/docs/MapiCalendarRecurrencePatternDto.md @@ -1,24 +1,27 @@ # AsposeEmailCloudSdk.models.MapiCalendarRecurrencePatternDto + +Mapi recurrence pattern. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**calendar_type** | **str** | Enumerated the calendar type of the mapi recurrence Enum, available values: Default, CalGregorian, CalGregorianUs, CalJapan, CalTaiwan, CalKorea, CalHijri, CalThai, CalHebrew, CalGregorianMeFrench, CalGregorianArabic, CalGregorianXLitEnglish, CalGregorianXLitFrench, CalLunarJapanese, CalChineseLunar, CalSaka, CalLunarEtoChn, CalLunarEtoKor, CalLunarRokuyou, CalLunarKorean, CalUmAlQura | -**deleted_instance_dates** | **list[datetime]** | An array of dates, each of which is the original instance date of either a deleted instance or a modified instance for this recurrence. | [optional] -**end_date** | **datetime** | End date of an item recurrence pattern. | -**end_type** | **str** | Enumerates the ending type for the recurrence. Enum, available values: None, EndAfterDate, EndAfterNOccurrences, NeverEnd | -**exceptions** | [**list[MapiCalendarExceptionInfoDto]**](MapiCalendarExceptionInfoDto.md) | An exception specifies changes to an instance of a recurring series. | [optional] -**frequency** | **str** | Enumerates mapi calendar recurrence frequency Enum, available values: None, Daily, Weekly, Monthly, Yearly | -**modified_instance_dates** | **list[datetime]** | An array of dates, each of which is the date of a modified instance. | [optional] -**occurrence_count** | **int** | Number of occurrences in a recurrence. | -**pattern_type** | **str** | Enumerates the mapi calendar recurrence pattern types Enum, available values: Day, Week, Month, MonthEnd, MonthNth, HjMonth, HjMonthNth, HjMonthEnd | -**period** | **int** | Interval at which the meeting pattern repeats. | -**sliding_flag** | **bool** | Defines whether pattern is sliding or not. | -**start_date** | **datetime** | Start date of an item recurrence pattern. | -**week_start_day** | **str** | Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | -**discriminator** | **str** | | +**calendar_type** |**str** |Enumerated the calendar type of the mapi recurrence Enum, available values: Default, CalGregorian, CalGregorianUs, CalJapan, CalTaiwan, CalKorea, CalHijri, CalThai, CalHebrew, CalGregorianMeFrench, CalGregorianArabic, CalGregorianXLitEnglish, CalGregorianXLitFrench, CalLunarJapanese, CalChineseLunar, CalSaka, CalLunarEtoChn, CalLunarEtoKor, CalLunarRokuyou, CalLunarKorean, CalUmAlQura | +**deleted_instance_dates** |**list[datetime]** |An array of dates, each of which is the original instance date of either a deleted instance or a modified instance for this recurrence. |[optional] +**end_date** |**datetime** |End date of an item recurrence pattern. | +**end_type** |**str** |Enumerates the ending type for the recurrence. Enum, available values: None, EndAfterDate, EndAfterNOccurrences, NeverEnd | +**exceptions** |[**list[MapiCalendarExceptionInfoDto]**](MapiCalendarExceptionInfoDto.md) |An exception specifies changes to an instance of a recurring series. |[optional] +**frequency** |**str** |Enumerates mapi calendar recurrence frequency Enum, available values: None, Daily, Weekly, Monthly, Yearly | +**modified_instance_dates** |**list[datetime]** |An array of dates, each of which is the date of a modified instance. |[optional] +**occurrence_count** |**int** |Number of occurrences in a recurrence. | +**pattern_type** |**str** |Enumerates the mapi calendar recurrence pattern types Enum, available values: Day, Week, Month, MonthEnd, MonthNth, HjMonth, HjMonthNth, HjMonthEnd | +**period** |**int** |Interval at which the meeting pattern repeats. | +**sliding_flag** |**bool** |Defines whether pattern is sliding or not. | +**start_date** |**datetime** |Start date of an item recurrence pattern. | +**week_start_day** |**str** |Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarSaveRequest.md b/sdk/docs/MapiCalendarSaveRequest.md index 8479da6..bdc9d4b 100644 --- a/sdk/docs/MapiCalendarSaveRequest.md +++ b/sdk/docs/MapiCalendarSaveRequest.md @@ -1,11 +1,53 @@ # AsposeEmailCloudSdk.models.MapiCalendarSaveRequest + +Save MapiCalendar to storage request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Calendar file format Enum, available values: Ics, Msg | +**format** |**str** |Calendar file format Enum, available values: Ics, Msg | - Parent class: [StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) +Parent class: [StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_calendar_save_request = models.MapiCalendarSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='calendar.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiCalendarDto( + attendees=models.MapiCalendarAttendeesDto( + appointment_recipients=[ + models.MapiRecipientDto( + email_address='organizer@aspose.com', + address_type='SMTP', + display_name='Organizer Name', + recipient_type='MapiTo'), + models.MapiRecipientDto( + email_address='attendee@aspose.com', + address_type='SMTP', + display_name='Attendee Name', + recipient_type='MapiTo')]), + busy_status='Tentative', + client_intent=[ + 'Manager'], + end_date=datetime.today(), + location='Some location', + recurrence=models.MapiCalendarEventRecurrenceDto( + recurrence_pattern=models.MapiCalendarDailyRecurrencePatternDto( + frequency='Daily', + occurrence_count=10, + week_start_day='Monday')), + start_date=datetime.today(), + organizer=models.MapiElectronicAddressDto( + email_address='organizer@aspose.com'), + body='Some description', + subject='Some summary')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarTimeZoneDto.md b/sdk/docs/MapiCalendarTimeZoneDto.md index a3a2283..ba5f47a 100644 --- a/sdk/docs/MapiCalendarTimeZoneDto.md +++ b/sdk/docs/MapiCalendarTimeZoneDto.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.MapiCalendarTimeZoneDto + +Represents the mapi calendar time zone information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key_name** | **str** | Human-readable description of the time zone. | [optional] -**time_zone_rules** | [**list[MapiCalendarTimeZoneInfoDto]**](MapiCalendarTimeZoneInfoDto.md) | Time zone rules | [optional] +**key_name** |**str** |Human-readable description of the time zone. |[optional] +**time_zone_rules** |[**list[MapiCalendarTimeZoneInfoDto]**](MapiCalendarTimeZoneInfoDto.md) |Time zone rules |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarTimeZoneInfoDto.md b/sdk/docs/MapiCalendarTimeZoneInfoDto.md index 30e3f0c..0856b46 100644 --- a/sdk/docs/MapiCalendarTimeZoneInfoDto.md +++ b/sdk/docs/MapiCalendarTimeZoneInfoDto.md @@ -1,17 +1,20 @@ # AsposeEmailCloudSdk.models.MapiCalendarTimeZoneInfoDto + +Represents the mapi calendar time zone rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bias** | **int** | Time zone's offset in minutes from UTC. | -**daylight_bias** | **int** | Offset in minutes from lBias during daylight saving time. | -**daylight_date** | [**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) | Date and local time that indicate when to begin using the DaylightBias. | [optional] -**standard_bias** | **int** | Offset in minutes from lBias during standard time. | -**standard_date** | [**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) | Date and local time that indicate when to begin using the StandardBias. | [optional] -**time_zone_flags** | **list[str]** | Individual bit flags that specify information about this TimeZoneRule. Items: Enumerates the individual bit flags that specify information about TimeZoneRule Enum, available values: TzRuleFlagRecurCurrentTzReg, TzRuleFlagEffectiveTzReg | [optional] -**year** | **int** | Year in which this rule is scheduled to take effect. | +**bias** |**int** |Time zone's offset in minutes from UTC. | +**daylight_bias** |**int** |Offset in minutes from lBias during daylight saving time. | +**daylight_date** |[**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) |Date and local time that indicate when to begin using the DaylightBias. |[optional] +**standard_bias** |**int** |Offset in minutes from lBias during standard time. | +**standard_date** |[**MapiCalendarTimeZoneRuleDto**](MapiCalendarTimeZoneRuleDto.md) |Date and local time that indicate when to begin using the StandardBias. |[optional] +**time_zone_flags** |**list[str]** |Individual bit flags that specify information about this TimeZoneRule. Items: Enumerates the individual bit flags that specify information about TimeZoneRule Enum, available values: TzRuleFlagRecurCurrentTzReg, TzRuleFlagEffectiveTzReg |[optional] +**year** |**int** |Year in which this rule is scheduled to take effect. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarTimeZoneRuleDto.md b/sdk/docs/MapiCalendarTimeZoneRuleDto.md index fb7799a..5ab6efb 100644 --- a/sdk/docs/MapiCalendarTimeZoneRuleDto.md +++ b/sdk/docs/MapiCalendarTimeZoneRuleDto.md @@ -1,19 +1,22 @@ # AsposeEmailCloudSdk.models.MapiCalendarTimeZoneRuleDto + +Represents time zone rule that indicate when to begin using the Standard/Daylight time. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_date** | **datetime** | Date and time that indicate when to begin using the Standard/Daylight time. | -**day_of_week** | **str** | Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | -**hour** | **int** | Hour. | -**milliseconds** | **int** | Milliseconds. | -**minute** | **int** | Minute. | -**month** | **int** | Month. | -**position** | **str** | Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | -**seconds** | **int** | Seconds. | -**year** | **int** | Year. | +**_date** |**datetime** |Date and time that indicate when to begin using the Standard/Daylight time. | +**day_of_week** |**str** |Day of week. Enum, available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | +**hour** |**int** |Hour. | +**milliseconds** |**int** |Milliseconds. | +**minute** |**int** |Minute. | +**month** |**int** |Month. | +**position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | +**seconds** |**int** |Seconds. | +**year** |**int** |Year. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md b/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md index 824cef8..f3f30e0 100644 --- a/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md +++ b/sdk/docs/MapiCalendarWeeklyRecurrencePatternDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiCalendarWeeklyRecurrencePatternDto + +Represents the weekly recurrence pattern of the mapi calendar + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**day_of_week** | **list[str]** | Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday | [optional] +**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] - Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) +Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md b/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md index 81bff96..f5f23a4 100644 --- a/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md +++ b/sdk/docs/MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md @@ -1,13 +1,17 @@ # AsposeEmailCloudSdk.models.MapiCalendarYearlyAndMonthlyRecurrencePatternDto + +Represents the yearly and monthly recurrence pattern of the mapi calendar + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**day** | **int** | Day of the month on which the recurrence falls. | -**day_of_week** | **list[str]** | Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday | [optional] -**position** | **str** | Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | +**day** |**int** |Day of the month on which the recurrence falls. | +**day_of_week** |**list[str]** |Days of week at which the event occurs. Items: Enumerates the days of week of the mapi calendar recurrence pattern Enum, available values: Saturday, Friday, Thursday, Wednesday, Tuesday, Monday, Sunday |[optional] +**position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) +Parent class: [MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiContactApi.md b/sdk/docs/MapiContactApi.md index 67eabb5..482463c 100644 --- a/sdk/docs/MapiContactApi.md +++ b/sdk/docs/MapiContactApi.md @@ -1,118 +1,495 @@ -# AsposeEmailCloudSdk.MapiContactApi +# AsposeEmailCloudSdk.MapiContactApi (EmailCloud.mapi.contact) + +MAPI contact operations - -# as_contact_dto +## as_contact_dto + +Description: Converts MAPI contact model to ContactDto model. + +Returns: Contact model. +Method call example: ```python -as_contact_dto(self, MapiContactDto mapi_contact_dto) +result = api.mapi.contact.as_contact_dto(mapi_contact_dto) ``` -Converts MAPI contact model to ContactDto model. +### Parameter: mapi_contact_dto + +Description: MAPI contact model to convert. + +See parameter model documentation at [MapiContactDto](MapiContactDto.md) -### Return type +
+ Parameter initialization example: + +```python +mapi_contact_dto = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` -[**ContactDto**](ContactDto.md) +
-### mapi_contact_dto Parameter +### Result -See parameter model documentation at [MapiContactDto](MapiContactDto.md) +Description: Contact model. + +Return type: [**ContactDto**](ContactDto.md) + +
+ Result example + +```python +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +mapi_contact_dto = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) + +// Call method: +result = api.mapi.contact.as_contact_dto(mapi_contact_dto) + +// Result example: +result = models.ContactDto( + attachments=[ + models.Attachment( + name='attachment.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + display_name='Alex Thomas', + email_addresses=[ + models.EmailAddress( + category=models.EnumWithCustomOfEmailAddressCategory( + value='Custom', + description='Partners'), + display_name='Alex Thomas Partners', + preferred=True, + address='email@aspose.com')], + gender='Male', + given_name='Alex', + phone_numbers=[ + models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Office'), + number='+49 211 4247 21', + preferred=True)], + profession='GENERAL DIRECTOR', + surname='Thomas', + urls=[ + models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='www.aspose.com')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_file +## as_file +Description: Converts MAPI contact model to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.mapi.contact.as_file(request) +``` + +### Parameter: request + +Description: MAPI contact model to convert. + +See parameter model documentation at [MapiContactAsFileRequest](MapiContactAsFileRequest.md) + +
+ Parameter initialization example: + ```python -as_file(self, MapiContactAsFileRequest request) +request = models.MapiContactAsFileRequest( + format='Msg', + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) ``` -Converts MAPI contact model to specified format and returns as file. +
-### Return type +### Result -**Stream** +Description: File stream in specified format. -### request Parameter +Return type: **Stream** -See parameter model documentation at [MapiContactAsFileRequest](MapiContactAsFileRequest.md) +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiContactAsFileRequest( + format='Msg', + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) + +// Call method: +result = api.mapi.contact.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts contact file to a MAPI model representation. + +Returns: MAPI model + +Method call example: +```python +result = api.mapi.contact.from_file(request) +``` + +### Parameter: request + +Description: from_file method request. +See parameter model documentation at [MapiContactFromFileRequest](MapiContactFromFileRequest.md). + +
+ Parameter initialization example: + ```python -from_file(self, request: MapiContactFromFileRequest) +request = models.MapiContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') ``` -Converts contact file to a MAPI model representation. +
+ +### Result + +Description: MAPI model + +Return type: [**MapiContactDto**](MapiContactDto.md) + +
+ Result example + +```python +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` +
-### Return type +### Complete example -MapiContactDto +
+ Method call example: -### request Parameter ```python -MapiContactFromFileRequest( - format, - file) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') + +// Call method: +result = api.mapi.contact.from_file(request) + +// Result example: +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | File format Enum, available values: VCard, WebDav, Msg | - **file** | **str** | File to convert | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get + +Description: Get MAPI contact document. + +Returns: Contact model. +Method call example: ```python -get(self, request: MapiContactGetRequest) +result = api.mapi.contact.get(request) ``` -Get MAPI contact document. +### Parameter: request -### Return type +Description: get method request. -MapiContactDto +See parameter model documentation at [MapiContactGetRequest](MapiContactGetRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -MapiContactGetRequest( - format, - file_name, - folder, - storage) +request = models.MapiContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Contact document format. Enum, available values: VCard, WebDav, Msg | - **file_name** | **str** | Contact document file name. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
+ +### Result + +Description: Contact model. + +Return type: [**MapiContactDto**](MapiContactDto.md) + +
+ Result example + +```python +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') + +// Call method: +result = api.mapi.contact.get(request) + +// Result example: +result = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save MAPI Contact to storage. +Method call example: ```python -save(self, MapiContactSaveRequest request) +api.mapi.contact.save(request) ``` -Save MAPI Contact to storage. +### Parameter: request -### Return type +Description: Create/Update contact request. -void (empty response body) +See parameter model documentation at [MapiContactSaveRequest](MapiContactSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.MapiContactSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='contact.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) +``` -See parameter model documentation at [MapiContactSaveRequest](MapiContactSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiContactSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='contact.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) + +// Call method: +api.mapi.contact.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactApi_list.md b/sdk/docs/MapiContactApi_list.md index a9ba54b..31d5186 100644 --- a/sdk/docs/MapiContactApi_list.md +++ b/sdk/docs/MapiContactApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for MapiContactApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/MapiContactAsFileRequest.md b/sdk/docs/MapiContactAsFileRequest.md index 0cc927c..a44906b 100644 --- a/sdk/docs/MapiContactAsFileRequest.md +++ b/sdk/docs/MapiContactAsFileRequest.md @@ -1,12 +1,34 @@ # AsposeEmailCloudSdk.models.MapiContactAsFileRequest + +Convert MapiContact to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | -**value** | [**MapiContactDto**](MapiContactDto.md) | MAPI contact model. | +**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | +**value** |[**MapiContactDto**](MapiContactDto.md) |MAPI contact model. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_contact_as_file_request = models.MapiContactAsFileRequest( + format='Msg', + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiContactDto.md b/sdk/docs/MapiContactDto.md index 56b7328..7ec3dfa 100644 --- a/sdk/docs/MapiContactDto.md +++ b/sdk/docs/MapiContactDto.md @@ -1,19 +1,40 @@ # AsposeEmailCloudSdk.models.MapiContactDto + +Represents outlook contact information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**electronic_addresses** | [**MapiContactElectronicAddressPropertySetDto**](MapiContactElectronicAddressPropertySetDto.md) | Specify properties for up to three different e-mail addresses and three different fax addresses. | [optional] -**events** | [**MapiContactEventPropertySetDto**](MapiContactEventPropertySetDto.md) | Specify events associated with a contact. | [optional] -**name_info** | [**MapiContactNamePropertySetDto**](MapiContactNamePropertySetDto.md) | The properties are used to specify the name of the person represented by the contact. | [optional] -**other_fields** | [**MapiContactOtherPropertySetDto**](MapiContactOtherPropertySetDto.md) | Specify other fields of contact. | [optional] -**personal_info** | [**MapiContactPersonalInfoPropertySetDto**](MapiContactPersonalInfoPropertySetDto.md) | Specify other additional contact information. | [optional] -**photo** | [**MapiContactPhotoDto**](MapiContactPhotoDto.md) | Contact photo. | [optional] -**physical_addresses** | [**MapiContactPhysicalAddressPropertySetDto**](MapiContactPhysicalAddressPropertySetDto.md) | Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address. | [optional] -**professional_info** | [**MapiContactProfessionalPropertySetDto**](MapiContactProfessionalPropertySetDto.md) | Properties are used to store professional details for the person represented by the contact. | [optional] -**telephones** | [**MapiContactTelephonePropertySetDto**](MapiContactTelephonePropertySetDto.md) | Specify telephone numbers for the contact. | [optional] - - Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) +**electronic_addresses** |[**MapiContactElectronicAddressPropertySetDto**](MapiContactElectronicAddressPropertySetDto.md) |Specify properties for up to three different e-mail addresses and three different fax addresses. |[optional] +**events** |[**MapiContactEventPropertySetDto**](MapiContactEventPropertySetDto.md) |Specify events associated with a contact. |[optional] +**name_info** |[**MapiContactNamePropertySetDto**](MapiContactNamePropertySetDto.md) |The properties are used to specify the name of the person represented by the contact. |[optional] +**other_fields** |[**MapiContactOtherPropertySetDto**](MapiContactOtherPropertySetDto.md) |Specify other fields of contact. |[optional] +**personal_info** |[**MapiContactPersonalInfoPropertySetDto**](MapiContactPersonalInfoPropertySetDto.md) |Specify other additional contact information. |[optional] +**photo** |[**MapiContactPhotoDto**](MapiContactPhotoDto.md) |Contact photo. |[optional] +**physical_addresses** |[**MapiContactPhysicalAddressPropertySetDto**](MapiContactPhysicalAddressPropertySetDto.md) |Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address. |[optional] +**professional_info** |[**MapiContactProfessionalPropertySetDto**](MapiContactProfessionalPropertySetDto.md) |Properties are used to store professional details for the person represented by the contact. |[optional] +**telephones** |[**MapiContactTelephonePropertySetDto**](MapiContactTelephonePropertySetDto.md) |Specify telephone numbers for the contact. |[optional] + +Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_contact_dto = models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactElectronicAddressDto.md b/sdk/docs/MapiContactElectronicAddressDto.md index 8e5d7e3..44a0971 100644 --- a/sdk/docs/MapiContactElectronicAddressDto.md +++ b/sdk/docs/MapiContactElectronicAddressDto.md @@ -1,16 +1,19 @@ # AsposeEmailCloudSdk.models.MapiContactElectronicAddressDto + +Refers to the group of properties that define the e-mail address or fax address for a contact. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address_type** | **str** | Address type of an electronic address | [optional] -**display_name** | **str** | User-readable display name for the e-mail address | [optional] -**email_address** | **str** | E-mail address of the contact | [optional] -**fax_number** | **str** | Telephone number of the mail user's primary fax machine | [optional] -**is_empty** | **bool** | Shows if MapiContactElectronicAddress is empty | -**original_display_name** | **str** | SMTP e-mail address that corresponds to the e-mail address for the Contact object. | [optional] +**address_type** |**str** |Address type of an electronic address |[optional] +**display_name** |**str** |User-readable display name for the e-mail address |[optional] +**email_address** |**str** |E-mail address of the contact |[optional] +**fax_number** |**str** |Telephone number of the mail user's primary fax machine |[optional] +**is_empty** |**bool** |Shows if MapiContactElectronicAddress is empty | +**original_display_name** |**str** |SMTP e-mail address that corresponds to the e-mail address for the Contact object. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactElectronicAddressPropertySetDto.md b/sdk/docs/MapiContactElectronicAddressPropertySetDto.md index 1a97e36..3cb8c4e 100644 --- a/sdk/docs/MapiContactElectronicAddressPropertySetDto.md +++ b/sdk/docs/MapiContactElectronicAddressPropertySetDto.md @@ -1,19 +1,22 @@ # AsposeEmailCloudSdk.models.MapiContactElectronicAddressPropertySetDto + +Specify properties for up to three different e-mail addresses (Email1, Email2, and Email3) and three different fax addresses (Primary Fax, Business Fax, and Home Fax) + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**business_fax** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the business fax address for a contact. | [optional] -**default_email_address** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' | [optional] -**email1** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the first e-mail address for a contact. | [optional] -**email2** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the second e-mail address for a contact. | [optional] -**email3** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the third e-mail address for a contact. | [optional] -**home_fax** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the home fax address for a contact. | [optional] -**is_empty** | **bool** | Shows if MapiContactElectronicAddressPropertySetDto is empty | -**primary_fax** | [**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) | Refers to the group of properties that define the primary fax address for a contact. | [optional] -**use_autocomplete** | **bool** | Indicates that one electronic address is completed automatically in case if user does not set any electronic address | +**business_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the business fax address for a contact. |[optional] +**default_email_address** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' |[optional] +**email1** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the first e-mail address for a contact. |[optional] +**email2** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the second e-mail address for a contact. |[optional] +**email3** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the third e-mail address for a contact. |[optional] +**home_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the home fax address for a contact. |[optional] +**is_empty** |**bool** |Shows if MapiContactElectronicAddressPropertySetDto is empty | +**primary_fax** |[**MapiContactElectronicAddressDto**](MapiContactElectronicAddressDto.md) |Refers to the group of properties that define the primary fax address for a contact. |[optional] +**use_autocomplete** |**bool** |Indicates that one electronic address is completed automatically in case if user does not set any electronic address | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactEventPropertySetDto.md b/sdk/docs/MapiContactEventPropertySetDto.md index f84af56..91435e0 100644 --- a/sdk/docs/MapiContactEventPropertySetDto.md +++ b/sdk/docs/MapiContactEventPropertySetDto.md @@ -1,12 +1,15 @@ # AsposeEmailCloudSdk.models.MapiContactEventPropertySetDto + +Specify events associated with a contact. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**birthday** | **datetime** | Specifies the birthday of the contact. | -**wedding_anniversary** | **datetime** | Specifies the wedding anniversary of the contact. | +**birthday** |**datetime** |Specifies the birthday of the contact. | +**wedding_anniversary** |**datetime** |Specifies the wedding anniversary of the contact. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactFromFileRequest.md b/sdk/docs/MapiContactFromFileRequest.md new file mode 100644 index 0000000..111d841 --- /dev/null +++ b/sdk/docs/MapiContactFromFileRequest.md @@ -0,0 +1,17 @@ +# MapiContactFromFileRequest + +Request model for MapiContactApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |File format Enum, available values: VCard, WebDav, Msg | +**file** |**str** |File to convert | + +## Example +```python +request = models.MapiContactFromFileRequest( + format='Msg', + file='/path/to/contact.msg') +``` diff --git a/sdk/docs/MapiContactGetRequest.md b/sdk/docs/MapiContactGetRequest.md new file mode 100644 index 0000000..daae3f0 --- /dev/null +++ b/sdk/docs/MapiContactGetRequest.md @@ -0,0 +1,21 @@ +# MapiContactGetRequest + +Request model for MapiContactApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Contact document format. Enum, available values: VCard, WebDav, Msg | +**file_name** |**str** |Contact document file name. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.MapiContactGetRequest( + format='VCard', + file_name='contact.vcf', + folder='folder/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/MapiContactNamePropertySetDto.md b/sdk/docs/MapiContactNamePropertySetDto.md index 495b9cb..7990edf 100644 --- a/sdk/docs/MapiContactNamePropertySetDto.md +++ b/sdk/docs/MapiContactNamePropertySetDto.md @@ -1,20 +1,23 @@ # AsposeEmailCloudSdk.models.MapiContactNamePropertySetDto + +The properties are used to specify the name of the person represented by the contact + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**display_name** | **str** | Full name of the contact | [optional] -**display_name_prefix** | **str** | Title of the contact | [optional] -**file_under** | **str** | Name under which to file this contact when displaying a list of contacts | [optional] -**file_under_id** | **int** | Value specifying how to generate and recompute the property when other properties are changed | -**generation** | **str** | Generation suffix of the contact | [optional] -**given_name** | **str** | Given name (first name) of the contact | [optional] -**initials** | **str** | Initials of the contact | [optional] -**middle_name** | **str** | Middle name of the contact | [optional] -**nickname** | **str** | Nickname of the contact | [optional] -**surname** | **str** | Surname (family name) of the contact | [optional] +**display_name** |**str** |Full name of the contact |[optional] +**display_name_prefix** |**str** |Title of the contact |[optional] +**file_under** |**str** |Name under which to file this contact when displaying a list of contacts |[optional] +**file_under_id** |**int** |Value specifying how to generate and recompute the property when other properties are changed | +**generation** |**str** |Generation suffix of the contact |[optional] +**given_name** |**str** |Given name (first name) of the contact |[optional] +**initials** |**str** |Initials of the contact |[optional] +**middle_name** |**str** |Middle name of the contact |[optional] +**nickname** |**str** |Nickname of the contact |[optional] +**surname** |**str** |Surname (family name) of the contact |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactOtherPropertySetDto.md b/sdk/docs/MapiContactOtherPropertySetDto.md index 3518c97..9aeb8f0 100644 --- a/sdk/docs/MapiContactOtherPropertySetDto.md +++ b/sdk/docs/MapiContactOtherPropertySetDto.md @@ -1,18 +1,21 @@ # AsposeEmailCloudSdk.models.MapiContactOtherPropertySetDto + +The properties are used to specify additional properties of contact. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**private** | **bool** | Indicates whether the end-user wants this message object hidden from other users who have access to the message object. | -**journal** | **bool** | Specifies whether to create a journal for each action associated with this contact. | -**reminder_time** | **datetime** | Specifies the initial signal time for a reminder. | -**reminder_topic** | **str** | Represents the status of a meeting request. | [optional] -**user_field1** | **str** | Specifies the first field on the contact that is intended for miscellaneous use for the contact. | [optional] -**user_field2** | **str** | Specifies the second field on the contact that is intended for miscellaneous use for the contact. | [optional] -**user_field3** | **str** | Specifies the third field on the contact that is intended for miscellaneous use for the contact. | [optional] -**user_field4** | **str** | Specifies the forth field on the contact that is intended for miscellaneous use for the contact. | [optional] +**private** |**bool** |Indicates whether the end-user wants this message object hidden from other users who have access to the message object. | +**journal** |**bool** |Specifies whether to create a journal for each action associated with this contact. | +**reminder_time** |**datetime** |Specifies the initial signal time for a reminder. | +**reminder_topic** |**str** |Represents the status of a meeting request. |[optional] +**user_field1** |**str** |Specifies the first field on the contact that is intended for miscellaneous use for the contact. |[optional] +**user_field2** |**str** |Specifies the second field on the contact that is intended for miscellaneous use for the contact. |[optional] +**user_field3** |**str** |Specifies the third field on the contact that is intended for miscellaneous use for the contact. |[optional] +**user_field4** |**str** |Specifies the forth field on the contact that is intended for miscellaneous use for the contact. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactPersonalInfoPropertySetDto.md b/sdk/docs/MapiContactPersonalInfoPropertySetDto.md index fdb4172..f1a0930 100644 --- a/sdk/docs/MapiContactPersonalInfoPropertySetDto.md +++ b/sdk/docs/MapiContactPersonalInfoPropertySetDto.md @@ -1,29 +1,32 @@ # AsposeEmailCloudSdk.models.MapiContactPersonalInfoPropertySetDto + +Specify other additional contact information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**spouse_name** | **str** | Specifies the name of the contact's spouse/partner | [optional] -**personal_home_page** | **str** | Specifies the contact's personal web page URL | [optional] -**language** | **str** | Specifies the language that the contact uses | [optional] -**notes** | **str** | Specifies the additional notes | [optional] -**hobbies** | **str** | Specifies the hobbies of the contact | [optional] -**location** | **str** | Specifies the location of the contact | [optional] -**instant_messaging_address** | **str** | Specifies the contact's instant messaging address | [optional] -**organizational_id_number** | **str** | Specifies an organizational ID number for the contact | [optional] -**customer_id** | **str** | Specifies the contact's customer ID number | [optional] -**government_id_number** | **str** | Specifies the contact's government ID number | [optional] -**free_busy_location** | **str** | Specifies a URL path from which a client can retrieve free/busy information for the contact as an iCal file | [optional] -**account** | **str** | Specifies the account name of the contact | [optional] -**html** | **str** | Specifies the contact's business web page URL | [optional] -**business_home_page** | **str** | Specifies the contact's business web page URL | [optional] -**ftp_site** | **str** | Specifies the contact's File Transfer Protocol (FTP) URL | [optional] -**computer_network_name** | **str** | Specifies the name of the network to which the contact's computer is connected | [optional] -**gender** | **str** | Gender of the contact Enum, available values: Unspecified, Female, Male | -**referred_by_name** | **str** | Specifies the name of the person who referred this contact to the user | [optional] -**children** | **list[str]** | Contains a list of names of children. | [optional] +**spouse_name** |**str** |Specifies the name of the contact's spouse/partner |[optional] +**personal_home_page** |**str** |Specifies the contact's personal web page URL |[optional] +**language** |**str** |Specifies the language that the contact uses |[optional] +**notes** |**str** |Specifies the additional notes |[optional] +**hobbies** |**str** |Specifies the hobbies of the contact |[optional] +**location** |**str** |Specifies the location of the contact |[optional] +**instant_messaging_address** |**str** |Specifies the contact's instant messaging address |[optional] +**organizational_id_number** |**str** |Specifies an organizational ID number for the contact |[optional] +**customer_id** |**str** |Specifies the contact's customer ID number |[optional] +**government_id_number** |**str** |Specifies the contact's government ID number |[optional] +**free_busy_location** |**str** |Specifies a URL path from which a client can retrieve free/busy information for the contact as an iCal file |[optional] +**account** |**str** |Specifies the account name of the contact |[optional] +**html** |**str** |Specifies the contact's business web page URL |[optional] +**business_home_page** |**str** |Specifies the contact's business web page URL |[optional] +**ftp_site** |**str** |Specifies the contact's File Transfer Protocol (FTP) URL |[optional] +**computer_network_name** |**str** |Specifies the name of the network to which the contact's computer is connected |[optional] +**gender** |**str** |Gender of the contact Enum, available values: Unspecified, Female, Male | +**referred_by_name** |**str** |Specifies the name of the person who referred this contact to the user |[optional] +**children** |**list[str]** |Contains a list of names of children. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactPhotoDto.md b/sdk/docs/MapiContactPhotoDto.md index 19c4d83..4df3714 100644 --- a/sdk/docs/MapiContactPhotoDto.md +++ b/sdk/docs/MapiContactPhotoDto.md @@ -1,10 +1,14 @@ # AsposeEmailCloudSdk.models.MapiContactPhotoDto + +Contains data and type of contact's photo. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ContactPhoto](ContactPhoto.md) +Parent class: [ContactPhoto](ContactPhoto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiContactPhysicalAddressDto.md b/sdk/docs/MapiContactPhysicalAddressDto.md index 94ed620..0f2323a 100644 --- a/sdk/docs/MapiContactPhysicalAddressDto.md +++ b/sdk/docs/MapiContactPhysicalAddressDto.md @@ -1,19 +1,22 @@ # AsposeEmailCloudSdk.models.MapiContactPhysicalAddressDto + +Refers to the group of properties that define physical address for a contact. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_mailing_address** | **bool** | Gets or sets a value indicating whether this address is mailing address | -**street** | **str** | Specifies the street portion of the contact's address | [optional] -**city** | **str** | Specifies the city or locality portion of the contact's address | [optional] -**state_or_province** | **str** | Specifies the state or province portion of the contact's address | [optional] -**postal_code** | **str** | Specifies the postal code (ZIP code) portion of the contact's address | [optional] -**country** | **str** | Specifies the country or region portion of the contact's address | [optional] -**country_code** | **str** | Specifies the country code portion of the contact's address | [optional] -**address** | **str** | Specifies the complete address of the contact's address | [optional] -**post_office_box** | **str** | Gets or sets the post office box | [optional] +**is_mailing_address** |**bool** |Gets or sets a value indicating whether this address is mailing address | +**street** |**str** |Specifies the street portion of the contact's address |[optional] +**city** |**str** |Specifies the city or locality portion of the contact's address |[optional] +**state_or_province** |**str** |Specifies the state or province portion of the contact's address |[optional] +**postal_code** |**str** |Specifies the postal code (ZIP code) portion of the contact's address |[optional] +**country** |**str** |Specifies the country or region portion of the contact's address |[optional] +**country_code** |**str** |Specifies the country code portion of the contact's address |[optional] +**address** |**str** |Specifies the complete address of the contact's address |[optional] +**post_office_box** |**str** |Gets or sets the post office box |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md b/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md index 02ae863..3ebda74 100644 --- a/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md +++ b/sdk/docs/MapiContactPhysicalAddressPropertySetDto.md @@ -1,13 +1,16 @@ # AsposeEmailCloudSdk.models.MapiContactPhysicalAddressPropertySetDto + +Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**work_address** | [**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) | Specifies the address of the contact's work | [optional] -**home_address** | [**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) | Specifies the address of the contact's home | [optional] -**other_address** | [**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) | Specifies the other contact's address | [optional] +**work_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the address of the contact's work |[optional] +**home_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the address of the contact's home |[optional] +**other_address** |[**MapiContactPhysicalAddressDto**](MapiContactPhysicalAddressDto.md) |Specifies the other contact's address |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactProfessionalPropertySetDto.md b/sdk/docs/MapiContactProfessionalPropertySetDto.md index 1851e32..fecf060 100644 --- a/sdk/docs/MapiContactProfessionalPropertySetDto.md +++ b/sdk/docs/MapiContactProfessionalPropertySetDto.md @@ -1,17 +1,20 @@ # AsposeEmailCloudSdk.models.MapiContactProfessionalPropertySetDto + +Properties are used to store professional details for the person represented by the contact + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**title** | **str** | Gets or sets the job title of the contact | [optional] -**company_name** | **str** | Gets or sets the company that employs the contact | [optional] -**department_name** | **str** | Gets or sets the name of the department to which the contact belongs | [optional] -**office_location** | **str** | Gets or sets the location of the office that the contact works in | [optional] -**manager_name** | **str** | Gets or sets the name of the contact's manager | [optional] -**assistant** | **str** | Gets or sets the name of the contact's assistant | [optional] -**profession** | **str** | Gets or sets the profession of the contact | [optional] +**title** |**str** |Gets or sets the job title of the contact |[optional] +**company_name** |**str** |Gets or sets the company that employs the contact |[optional] +**department_name** |**str** |Gets or sets the name of the department to which the contact belongs |[optional] +**office_location** |**str** |Gets or sets the location of the office that the contact works in |[optional] +**manager_name** |**str** |Gets or sets the name of the contact's manager |[optional] +**assistant** |**str** |Gets or sets the name of the contact's assistant |[optional] +**profession** |**str** |Gets or sets the profession of the contact |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactSaveRequest.md b/sdk/docs/MapiContactSaveRequest.md index 796e771..d7c48b9 100644 --- a/sdk/docs/MapiContactSaveRequest.md +++ b/sdk/docs/MapiContactSaveRequest.md @@ -1,11 +1,38 @@ # AsposeEmailCloudSdk.models.MapiContactSaveRequest + +MapiContact save to storage request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | +**format** |**str** |Enumerates contact formats. Enum, available values: VCard, WebDav, Msg | - Parent class: [StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) +Parent class: [StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_contact_save_request = models.MapiContactSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='contact.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiContactDto( + electronic_addresses=models.MapiContactElectronicAddressPropertySetDto( + default_email_address=models.MapiContactElectronicAddressDto( + email_address='email@aspose.com')), + name_info=models.MapiContactNamePropertySetDto( + given_name='Alex', + surname='Thomas'), + personal_info=models.MapiContactPersonalInfoPropertySetDto( + business_home_page='www.aspose.com'), + professional_info=models.MapiContactProfessionalPropertySetDto( + profession='GENERAL DIRECTOR'), + telephones=models.MapiContactTelephonePropertySetDto( + primary_telephone_number='+49 211 4247 21'))) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiContactTelephonePropertySetDto.md b/sdk/docs/MapiContactTelephonePropertySetDto.md index ad74ab3..0d3bbbb 100644 --- a/sdk/docs/MapiContactTelephonePropertySetDto.md +++ b/sdk/docs/MapiContactTelephonePropertySetDto.md @@ -1,29 +1,32 @@ # AsposeEmailCloudSdk.models.MapiContactTelephonePropertySetDto + +Specify optional telephone numbers for the contact. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_empty** | **bool** | Shows if MapiContactTelephonePropertySet is empty | -**default_telephone_number** | **str** | Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' | [optional] -**use_autocomplete** | **bool** | Indicates that one electronic address is completed automatically in case if user does not set any electronic address | -**callback_telephone_number** | **str** | Gets or sets the callback telephone number | [optional] -**business_telephone_number** | **str** | Gets or sets the business telephone number | [optional] -**home_telephone_number** | **str** | Gets or sets the home telephone number | [optional] -**primary_telephone_number** | **str** | Gets or sets the primary telephone number | [optional] -**business2_telephone_number** | **str** | Gets or sets the second business telephone number | [optional] -**mobile_telephone_number** | **str** | Gets or sets the mobile telephone number | [optional] -**radio_telephone_number** | **str** | Gets or sets the radio telephone number | [optional] -**car_telephone_number** | **str** | Gets or sets the car telephone number | [optional] -**other_telephone_number** | **str** | Gets or sets an alternate telephone number | [optional] -**assistant_telephone_number** | **str** | Gets or sets the telephone number of the contact's assistant | [optional] -**home2_telephone_number** | **str** | Gets or sets a second home telephone number | [optional] -**tty_tdd_phone_number** | **str** | Gets or sets the telephone number for the contact's text telephone (TTY) or telecommunication device for the deaf (TDD) | [optional] -**company_main_telephone_number** | **str** | Gets or sets the company phone number | [optional] -**telex_number** | **str** | Gets or sets the telex number | [optional] -**isdn_number** | **str** | Gets or sets the integrated services digital network (ISDN) number | [optional] -**pager_telephone_number** | **str** | Gets or sets a pager telephone number | [optional] +**is_empty** |**bool** |Shows if MapiContactTelephonePropertySet is empty | +**default_telephone_number** |**str** |Default value of electronic address Uses when user does not set any electronic address if UseAutocomplete property is set 'true' |[optional] +**use_autocomplete** |**bool** |Indicates that one electronic address is completed automatically in case if user does not set any electronic address | +**callback_telephone_number** |**str** |Gets or sets the callback telephone number |[optional] +**business_telephone_number** |**str** |Gets or sets the business telephone number |[optional] +**home_telephone_number** |**str** |Gets or sets the home telephone number |[optional] +**primary_telephone_number** |**str** |Gets or sets the primary telephone number |[optional] +**business2_telephone_number** |**str** |Gets or sets the second business telephone number |[optional] +**mobile_telephone_number** |**str** |Gets or sets the mobile telephone number |[optional] +**radio_telephone_number** |**str** |Gets or sets the radio telephone number |[optional] +**car_telephone_number** |**str** |Gets or sets the car telephone number |[optional] +**other_telephone_number** |**str** |Gets or sets an alternate telephone number |[optional] +**assistant_telephone_number** |**str** |Gets or sets the telephone number of the contact's assistant |[optional] +**home2_telephone_number** |**str** |Gets or sets a second home telephone number |[optional] +**tty_tdd_phone_number** |**str** |Gets or sets the telephone number for the contact's text telephone (TTY) or telecommunication device for the deaf (TDD) |[optional] +**company_main_telephone_number** |**str** |Gets or sets the company phone number |[optional] +**telex_number** |**str** |Gets or sets the telex number |[optional] +**isdn_number** |**str** |Gets or sets the integrated services digital network (ISDN) number |[optional] +**pager_telephone_number** |**str** |Gets or sets a pager telephone number |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiDateTimePropertyDto.md b/sdk/docs/MapiDateTimePropertyDto.md index 0e1bfb0..8261434 100644 --- a/sdk/docs/MapiDateTimePropertyDto.md +++ b/sdk/docs/MapiDateTimePropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiDateTimePropertyDto + +Mapi property with DateTime value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **datetime** | Property value | +**value** |**datetime** |Property value | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiElectronicAddressDto.md b/sdk/docs/MapiElectronicAddressDto.md index cab2657..962ad71 100644 --- a/sdk/docs/MapiElectronicAddressDto.md +++ b/sdk/docs/MapiElectronicAddressDto.md @@ -1,15 +1,18 @@ # AsposeEmailCloudSdk.models.MapiElectronicAddressDto + +Refers to the group of properties that define the e-mail address or fax address. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address_type** | **str** | Address type. | [optional] -**email_address** | **str** | Email address. | [optional] -**display_name** | **str** | User-readable display name for the e-mail address. | [optional] -**fax_number** | **str** | Telephone number of the mail user's primary fax machine. | [optional] -**original_display_name** | **str** | SMTP e-mail address that corresponds to the e-mail address. | [optional] +**address_type** |**str** |Address type. |[optional] +**email_address** |**str** |Email address. |[optional] +**display_name** |**str** |User-readable display name for the e-mail address. |[optional] +**fax_number** |**str** |Telephone number of the mail user's primary fax machine. |[optional] +**original_display_name** |**str** |SMTP e-mail address that corresponds to the e-mail address. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiFileAsPropertyDto.md b/sdk/docs/MapiFileAsPropertyDto.md index ec53dac..fb1e929 100644 --- a/sdk/docs/MapiFileAsPropertyDto.md +++ b/sdk/docs/MapiFileAsPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiFileAsPropertyDto + +Mapi property with FileAsMapping value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Defines how to construct what is displayed for a contact in the FileAs property. Enum, available values: None, LastCommaFirst, FirstSpaceLast, Company, LastCommaFirstCompany, CompanyLastFirst, LastFirst, LastFirstCompany, CompanyLastCommaFirst, LastFirstSuffix, LastSpaceFirstCompany, CompanyLastSpaceFirst, LastSpaceFirst, DisplayName, FirstName, LastFirstMiddleSuffix, LastName, Empty | +**value** |**str** |Defines how to construct what is displayed for a contact in the FileAs property. Enum, available values: None, LastCommaFirst, FirstSpaceLast, Company, LastCommaFirstCompany, CompanyLastFirst, LastFirst, LastFirstCompany, CompanyLastCommaFirst, LastFirstSuffix, LastSpaceFirstCompany, CompanyLastSpaceFirst, LastSpaceFirst, DisplayName, FirstName, LastFirstMiddleSuffix, LastName, Empty | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiImportancePropertyDto.md b/sdk/docs/MapiImportancePropertyDto.md index 06c7b5a..6b7d445 100644 --- a/sdk/docs/MapiImportancePropertyDto.md +++ b/sdk/docs/MapiImportancePropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiImportancePropertyDto + +Mapi property with ImportanceChoicesType value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Levels of importance for an item. Enum, available values: Low, Normal, High | +**value** |**str** |Levels of importance for an item. Enum, available values: Low, Normal, High | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiIntPropertyDto.md b/sdk/docs/MapiIntPropertyDto.md index 3fb9e25..cca0d9b 100644 --- a/sdk/docs/MapiIntPropertyDto.md +++ b/sdk/docs/MapiIntPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiIntPropertyDto + +Mapi property with Integer value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **int** | Property value | +**value** |**int** |Property value | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiKnownPropertyDescriptor.md b/sdk/docs/MapiKnownPropertyDescriptor.md index 83ccafe..3c78e2e 100644 --- a/sdk/docs/MapiKnownPropertyDescriptor.md +++ b/sdk/docs/MapiKnownPropertyDescriptor.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiKnownPropertyDescriptor + +Known Mapi Property descriptor + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Known property name. See all known properties here: https://apireference.aspose.com/email/net/aspose.email.mapi/knownpropertylist/fields/index Possible values: Mileage, ObjectUri, GDataContactVersion, GDataPhotoVersion, AddressBookProviderArrayType, AddressBookProviderEmailList, AddressCountryCode, AgingDontAgeMe, AllAttendeesString, AllowExternalCheck, AnniversaryEventEntryId, AppointmentAuxiliaryFlags, AppointmentColor, AppointmentCounterProposal, AppointmentDuration, AppointmentEndDate, AppointmentEndTime, AppointmentEndWhole, AppointmentLastSequence, AppointmentMessageClass, AppointmentNotAllowPropose, AppointmentProposalNumber, AppointmentProposedDuration, AppointmentProposedEndWhole, AppointmentProposedStartWhole, AppointmentRecur, AppointmentReplyName, AppointmentReplyTime, AppointmentSequence, AppointmentSequenceTime, AppointmentStartDate, AppointmentStartTime, AppointmentStartWhole, AppointmentStateFlags, AppointmentSubType, AppointmentTimeZoneDefinitionEndDisplay, AppointmentTimeZoneDefinitionRecur, AppointmentTimeZoneDefinitionStartDisplay, AppointmentUnsendableRecipients, AppointmentUpdateTime, AttendeeCriticalChange, AutoFillLocation, AutoLog, AutoProcessState, AutoStartCheck, Billing, BirthdayEventEntryId, BirthdayLocal, BusinessCardCardPicture, BusinessCardDisplayDefinition, BusyStatus, CalendarType, Categories, CcAttendeesString, ChangeHighlight, Classification, ClassificationDescription, ClassificationGuid, ClassificationKeep, Classified, CleanGlobalObjectId, ClientIntent, ClipEnd, ClipStart, CollaborateDoc, CommonEnd, CommonStart, Companies, ConferencingCheck, ConferencingType, ContactCharacterSet, ContactItemData, ContactLinkedGlobalAddressListEntryId, ContactLinkEntry, ContactLinkGlobalAddressListLinkId, ContactLinkGlobalAddressListLinkState, ContactLinkLinkRejectHistory, ContactLinkName, ContactLinkSearchKey, ContactLinkSMTPAddressCache, Contacts, ContactUserField1, ContactUserField2, ContactUserField3, ContactUserField4, ConversationActionLastAppliedTime, ConversationActionMaxDeliveryTime, ConversationActionMoveFolderEid, ConversationActionMoveStoreEid, ConversationActionVersion, ConversationProcessed, CurrentVersion, CurrentVersionName, DayInterval, DayOfMonth, DelegateMail, Department, Directory, DistributionListChecksum, DistributionListMembers, DistributionListName, DistributionListOneOffMembers, DistributionListStream, Email1AddressType, Email1DisplayName, Email1EmailAddress, Email1OriginalDisplayName, Email1OriginalEntryId, Email2AddressType, Email2DisplayName, Email2EmailAddress, Email2OriginalDisplayName, Email2OriginalEntryId, Email3AddressType, Email3DisplayName, Email3EmailAddress, Email3OriginalDisplayName, Email3OriginalEntryId, EndRecurrenceDate, EndRecurrenceTime, ExceptionReplaceTime, Fax1AddressType, Fax1EmailAddress, Fax1OriginalDisplayName, Fax1OriginalEntryId, Fax2AddressType, Fax2EmailAddress, Fax2OriginalDisplayName, Fax2OriginalEntryId, Fax3AddressType, Fax3EmailAddress, Fax3OriginalDisplayName, Fax3OriginalEntryId, FExceptionalAttendees, FExceptionalBody, FileUnder, FileUnderId, FileUnderList, FInvited, FlagRequest, FlagString, ForwardInstance, ForwardNotificationRecipients, FOthersAppointment, FreeBusyLocation, GlobalObjectId, HasPicture, HomeAddress, HomeAddressCountryCode, Html, ICalendarDayOfWeekMask, InboundICalStream, InfoPathFormName, InstantMessagingAddress, IntendedBusyStatus, InternetAccountName, InternetAccountStamp, IsContactLinked, IsException, IsRecurring, IsSilent, LinkedTaskItems, Location, LogDocumentPosted, LogDocumentPrinted, LogDocumentRouted, LogDocumentSaved, LogDuration, LogEnd, LogFlags, LogStart, LogType, LogTypeDesc, MeetingType, MeetingWorkspaceUrl, MonthInterval, MonthOfYear, MonthOfYearMask, NetShowUrl, NoEndDateFlag, NonSendableBcc, NonSendableCc, NonSendableTo, NonSendBccTrackStatus, NonSendCcTrackStatus, NonSendToTrackStatus, NoteColor, NoteHeight, NoteWidth, NoteX, NoteY, Occurrences, OldLocation, OldRecurrenceType, OldWhenEndWhole, OldWhenStartWhole, OnlinePassword, OptionalAttendees, OrganizerAlias, OriginalStoreEntryId, OtherAddress, OtherAddressCountryCode, OwnerCriticalChange, OwnerName, PendingStateForSiteMailboxDocument, PercentComplete, PostalAddressId, PostRssChannel, PostRssChannelLink, PostRssItemGuid, PostRssItemHash, PostRssItemLink, PostRssItemXml, PostRssSubscription, Private, PromptSendUpdate, RecurrenceDuration, RecurrencePattern, RecurrenceType, Recurring, ReferenceEntryId, ReminderDelta, ReminderFileParameter, ReminderOverride, ReminderPlaySound, ReminderSet, ReminderSignalTime, ReminderTime, ReminderTimeDate, ReminderTimeTime, ReminderType, RemoteStatus, RequiredAttendees, ResourceAttendees, ResponseStatus, ServerProcessed, ServerProcessingActions, SharingAnonymity, SharingBindingEntryId, SharingBrowseUrl, SharingCapabilities, SharingConfigurationUrl, SharingDataRangeEnd, SharingDataRangeStart, SharingDetail, SharingExtensionXml, SharingFilter, SharingFlags, SharingFlavor, SharingFolderEntryId, SharingIndexEntryId, SharingInitiatorEntryId, SharingInitiatorName, SharingInitiatorSmtp, SharingInstanceGuid, SharingLastAutoSyncTime, SharingLastSyncTime, SharingLocalComment, SharingLocalLastModificationTime, SharingLocalName, SharingLocalPath, SharingLocalStoreUid, SharingLocalType, SharingLocalUid, SharingOriginalMessageEntryId, SharingParentBindingEntryId, SharingParticipants, SharingPermissions, SharingProviderExtension, SharingProviderGuid, SharingProviderName, SharingProviderUrl, SharingRangeEnd, SharingRangeStart, SharingReciprocation, SharingRemoteByteSize, SharingRemoteComment, SharingRemoteCrc, SharingRemoteLastModificationTime, SharingRemoteMessageCount, SharingRemoteName, SharingRemotePass, SharingRemotePath, SharingRemoteStoreUid, SharingRemoteType, SharingRemoteUid, SharingRemoteUser, SharingRemoteVersion, SharingResponseTime, SharingResponseType, SharingRoamLog, SharingStart, SharingStatus, SharingStop, SharingSyncFlags, SharingSyncInterval, SharingTimeToLive, SharingTimeToLiveAuto, SharingWorkingHoursDays, SharingWorkingHoursEnd, SharingWorkingHoursStart, SharingWorkingHoursTimeZone, SideEffects, SingleBodyICal, SmartNoAttach, SpamOriginalFolder, StartRecurrenceDate, StartRecurrenceTime, TaskAcceptanceState, TaskAccepted, TaskActualEffort, TaskAssigner, TaskAssigners, TaskComplete, TaskCustomFlags, TaskDateCompleted, TaskDeadOccurrence, TaskDueDate, TaskEstimatedEffort, TaskFCreator, TaskFFixOffline, TaskFRecurring, TaskGlobalId, TaskHistory, TaskLastDelegate, TaskLastUpdate, TaskLastUser, TaskMode, TaskMultipleRecipients, TaskNoCompute, TaskOrdinal, TaskOwner, TaskOwnership, TaskRecurrence, TaskResetReminder, TaskRole, TaskStartDate, TaskState, TaskStatus, TaskStatusOnComplete, TaskUpdates, TaskVersion, TeamTask, TimeZone, TimeZoneDescription, TimeZoneStruct, ToAttendeesString, ToDoOrdinalDate, ToDoSubOrdinal, ToDoTitle, UseTnef, ValidFlagStringProof, VerbResponse, VerbStream, WeddingAnniversaryLocal, WeekInterval, Where, WorkAddress, WorkAddressCity, WorkAddressCountry, WorkAddressCountryCode, WorkAddressPostalCode, WorkAddressPostOfficeBox, WorkAddressState, WorkAddressStreet, YearInterval, YomiCompanyName, YomiFirstName, YomiLastName, AcceptLanguage, ApplicationName, AttachmentMacContentType, AttachmentMacInfo, AudioNotes, Author, AutomaticSpeechRecognitionData, ByteCount, CalendarAttendeeRole, CalendarBusystatus, CalendarContact, CalendarContactUrl, CalendarCreated, CalendarDescriptionUrl, CalendarDuration, CalendarExceptionDate, CalendarExceptionRule, CalendarGeoLatitude, CalendarGeoLongitude, CalendarInstanceType, CalendarIsOrganizer, CalendarLastModified, CalendarLocationUrl, CalendarMeetingStatus, CalendarMethod, CalendarProductId, CalendarRecurrenceIdRange, CalendarReminderOffset, CalendarResources, CalendarRsvp, CalendarSequence, CalendarTimeZone, CalendarTimeZoneId, CalendarTransparent, CalendarUid, CalendarVersion, Category, CharacterCount, Comments, Company, ContentBase, ContentClass, ContentType, CreateDateTimeReadOnly, CrossReference, DavId, DavIsCollection, DavIsStructuredDocument, DavParentName, DavUid, DocumentParts, EditTime, ExchangeIntendedBusyStatus, ExchangeJunkEmailMoveStamp, ExchangeModifyExceptionStructure, ExchangeNoModifyExceptions, ExchangePatternEnd, ExchangePatternStart, ExchangeReminderInterval, ExchDatabaseSchema, ExchDataExpectedContentClass, ExchDataSchemaCollectionReference, ExtractedAddresses, ExtractedContacts, ExtractedEmails, ExtractedMeetings, ExtractedPhones, ExtractedTasks, ExtractedUrls, From, HeadingPairs, HiddenCount, HttpmailCalendar, HttpmailHtmlDescription, HttpmailSendMessage, ICalendarRecurrenceDate, ICalendarRecurrenceRule, InternetSubject, Keywords, LastAuthor, LastPrinted, LastSaveDateTime, LineCount, LinksDirty, LocationUrl, Manager, MultimediaClipCount, NoteCount, OMSAccountGuid, OMSMobileModel, OMSScheduleTime, OMSServiceType, OMSSourceType, PageCount, ParagraphCount, PhishingStamp, PresentationFormat, QuarantineOriginalSender, RevisionNumber, RightsManagementLicense, Scale, Security, SlideCount, Subject, Template, Thumbnail, Title, WordCount, XCallId, XFaxNumberOfPages, XRequireProtectedPlayOnPhone, XSenderTelephoneNumber, XSharingBrowseUrl, XSharingCapabilities, XSharingConfigUrl, XSharingExendedCaps, XSharingFlavor, XSharingInstanceGuid, XSharingLocalType, XSharingProviderGuid, XSharingProviderName, XSharingProviderUrl, XSharingRemoteName, XSharingRemotePath, XSharingRemoteStoreUid, XSharingRemoteType, XSharingRemoteUid, XVoiceMessageAttachmentOrder, XVoiceMessageDuration, XVoiceMessageSenderName, Access, AccessControlListData, AccessLevel, Account, AdditionalRenEntryIds, AdditionalRenEntryIdsEx, AddressBookAuthorizedSenders, AddressBookContainerId, AddressBookDeliveryContentLength, AddressBookDisplayNamePrintable, AddressBookDisplayTypeExtended, AddressBookDistributionListExternalMemberCount, AddressBookDistributionListMemberCount, AddressBookDistributionListMemberSubmitAccepted, AddressBookDistributionListMemberSubmitRejected, AddressBookDistributionListRejectMessagesFromDLMembers, AddressBookEntryId, AddressBookExtensionAttribute1, AddressBookExtensionAttribute10, AddressBookExtensionAttribute11, AddressBookExtensionAttribute12, AddressBookExtensionAttribute13, AddressBookExtensionAttribute14, AddressBookExtensionAttribute15, AddressBookExtensionAttribute2, AddressBookExtensionAttribute3, AddressBookExtensionAttribute4, AddressBookExtensionAttribute5, AddressBookExtensionAttribute6, AddressBookExtensionAttribute7, AddressBookExtensionAttribute8, AddressBookExtensionAttribute9, AddressBookFolderPathname, AddressBookHierarchicalChildDepartments, AddressBookHierarchicalDepartmentMembers, AddressBookHierarchicalIsHierarchicalGroup, AddressBookHierarchicalParentDepartment, AddressBookHierarchicalRootDepartment, AddressBookHierarchicalShowInDepartments, AddressBookHomeMessageDatabase, AddressBookIsMaster, AddressBookIsMemberOfDistributionList, AddressBookManageDistributionList, AddressBookManager, AddressBookManagerDistinguishedName, AddressBookMember, AddressBookMessageId, AddressBookModerationEnabled, AddressBookNetworkAddress, AddressBookObjectDistinguishedName, AddressBookObjectGuid, AddressBookOrganizationalUnitRootDistinguishedName, AddressBookOwner, AddressBookOwnerBackLink, AddressBookParentEntryId, AddressBookPhoneticCompanyName, AddressBookPhoneticDepartmentName, AddressBookPhoneticDisplayName, AddressBookPhoneticGivenName, AddressBookPhoneticSurname, AddressBookProxyAddresses, AddressBookPublicDelegates, AddressBookReports, AddressBookRoomCapacity, AddressBookRoomContainers, AddressBookRoomDescription, AddressBookSenderHintTranslations, AddressBookSeniorityIndex, AddressBookTargetAddress, AddressBookUnauthorizedSenders, AddressBookX509Certificate, AddressType, AlternateRecipientAllowed, Anr, ArchiveDate, ArchivePeriod, ArchiveTag, Assistant, AssistantTelephoneNumber, Associated, AttachAdditionalInformation, AttachContentBase, AttachContentId, AttachContentLocation, AttachDataBinary, AttachDataObject, AttachEncoding, AttachExtension, AttachFilename, AttachFlags, AttachLongFilename, AttachLongPathname, AttachmentContactPhoto, AttachmentFlags, AttachmentHidden, AttachmentLinkId, AttachMethod, AttachMimeTag, AttachNumber, AttachPathname, AttachPayloadClass, AttachPayloadProviderGuidString, AttachRendering, AttachSize, AttachTag, AttachTransportName, AttributeHidden, AttributeReadOnly, AutoForwardComment, AutoForwarded, AutoResponseSuppress, Birthday, BlockStatus, Body, BodyContentId, BodyContentLocation, BodyHtml, Business2TelephoneNumber, Business2TelephoneNumbers, BusinessFaxNumber, BusinessHomePage, BusinessTelephoneNumber, CallbackTelephoneNumber, CallId, CarTelephoneNumber, CdoRecurrenceid, ChangeKey, ChangeNumber, ChildrensNames, ClientActions, ClientSubmitTime, CodePageId, Comment, CompanyMainTelephoneNumber, CompanyName, ComputerNetworkName, ConflictEntryId, ContainerClass, ContainerContents, ContainerFlags, ContainerHierarchy, ContentCount, ContentFilterSpamConfidenceLevel, ContentUnreadCount, ConversationId, ConversationIndex, ConversationIndexTracking, ConversationTopic, Country, CreationTime, CreatorEntryId, CreatorName, CustomerId, DamBackPatched, DamOriginalEntryId, DefaultPostMessageClass, DeferredActionMessageOriginalEntryId, DeferredDeliveryTime, DeferredSendNumber, DeferredSendTime, DeferredSendUnits, DelegatedByRule, DelegateFlags, DeleteAfterSubmit, DeletedCountTotal, DeletedOn, DeliverTime, DepartmentName, Depth, DisplayBcc, DisplayCc, DisplayName, DisplayNamePrefix, DisplayTo, DisplayType, DisplayTypeEx, EmailAddress, EndDate, EntryId, ExceptionEndTime, TagExceptionReplaceTime, ExceptionStartTime, ExchangeNTSecurityDescriptor, ExpiryNumber, ExpiryTime, ExpiryUnits, ExtendedFolderFlags, ExtendedRuleMessageActions, ExtendedRuleMessageCondition, ExtendedRuleSizeLimit, FaxNumberOfPages, FlagCompleteTime, FlagStatus, FlatUrlName, FolderAssociatedContents, FolderId, FolderFlags, FolderType, FollowupIcon, FreeBusyCountMonths, FreeBusyEntryIds, FreeBusyMessageEmailAddress, FreeBusyPublishEnd, FreeBusyPublishStart, FreeBusyRangeTimestamp, FtpSite, GatewayNeedsToRefresh, Gender, Generation, GivenName, GovernmentIdNumber, HasAttachments, HasDeferredActionMessages, HasNamedProperties, HasRules, HierarchyChangeNumber, HierRev, Hobbies, Home2TelephoneNumber, Home2TelephoneNumbers, HomeAddressCity, HomeAddressCountry, HomeAddressPostalCode, HomeAddressPostOfficeBox, HomeAddressStateOrProvince, HomeAddressStreet, HomeFaxNumber, HomeTelephoneNumber, TagHtml, ICalendarEndTime, ICalendarReminderNextTime, ICalendarStartTime, IconIndex, Importance, InConflict, InitialDetailsPane, Initials, InReplyToId, InstanceKey, InstanceNum, InstID, InternetCodepage, InternetMailOverrideFormat, InternetMessageId, InternetReferences, IpmAppointmentEntryId, IpmContactEntryId, IpmDraftsEntryId, IpmJournalEntryId, IpmNoteEntryId, IpmTaskEntryId, IsdnNumber, JunkAddRecipientsToSafeSendersList, JunkIncludeContacts, JunkPermanentlyDelete, JunkPhishingEnableLinks, JunkThreshold, Keyword, Language, LastModificationTime, LastModifierEntryId, LastModifierName, LastVerbExecuted, LastVerbExecutionTime, ListHelp, ListSubscribe, ListUnsubscribe, LocalCommitTime, LocalCommitTimeMax, LocaleId, Locality, TagLocation, MailboxOwnerEntryId, MailboxOwnerName, ManagerName, MappingSignature, MaximumSubmitMessageSize, MemberId, MemberName, MemberRights, MessageAttachments, MessageCcMe, MessageClass, MessageCodepage, MessageDeliveryTime, MessageEditorFormat, MessageFlags, MessageHandlingSystemCommonName, MessageLocaleId, MessageRecipientMe, MessageRecipients, MessageSize, MessageSizeExtended, MessageStatus, MessageSubmissionId, MessageToMe, Mid, MiddleName, MimeSkeleton, MobileTelephoneNumber, NativeBody, NextSendAcct, Nickname, NonDeliveryReportDiagCode, NonDeliveryReportReasonCode, NonDeliveryReportStatusCode, NonReceiptNotificationRequested, NormalizedSubject, ObjectType, OfficeLocation, OfflineAddressBookContainerGuid, OfflineAddressBookDistinguishedName, OfflineAddressBookMessageClass, OfflineAddressBookName, OfflineAddressBookSequence, OfflineAddressBookTruncatedProperties, OrdinalMost, OrganizationalIdNumber, OriginalAuthorEntryId, OriginalAuthorName, OriginalDeliveryTime, OriginalDisplayBcc, OriginalDisplayCc, OriginalDisplayTo, OriginalEntryId, OriginalMessageClass, OriginalMessageId, OriginalSenderAddressType, OriginalSenderEmailAddress, OriginalSenderEntryId, OriginalSenderName, OriginalSenderSearchKey, OriginalSensitivity, OriginalSentRepresentingAddressType, OriginalSentRepresentingEmailAddress, OriginalSentRepresentingEntryId, OriginalSentRepresentingName, OriginalSentRepresentingSearchKey, OriginalSubject, OriginalSubmitTime, OriginatorDeliveryReportRequested, OriginatorNonDeliveryReportRequested, OscSyncEnabled, OtherAddressCity, OtherAddressCountry, OtherAddressPostalCode, OtherAddressPostOfficeBox, OtherAddressStateOrProvince, OtherAddressStreet, OtherTelephoneNumber, OutOfOfficeState, OwnerAppointmentId, PagerTelephoneNumber, ParentEntryId, ParentFolderId, ParentKey, ParentSourceKey, PersonalHomePage, PolicyTag, PostalAddress, PostalCode, PostOfficeBox, PredecessorChangeList, PrimaryFaxNumber, PrimarySendAccount, PrimaryTelephoneNumber, Priority, Processed, Profession, ProhibitReceiveQuota, ProhibitSendQuota, PurportedSenderDomain, RadioTelephoneNumber, Read, ReadReceiptAddressType, ReadReceiptEmailAddress, ReadReceiptEntryId, ReadReceiptName, ReadReceiptRequested, ReadReceiptSearchKey, ReadReceiptSmtpAddress, ReceiptTime, ReceivedByAddressType, ReceivedByEmailAddress, ReceivedByEntryId, ReceivedByName, ReceivedBySearchKey, ReceivedBySmtpAddress, ReceivedRepresentingAddressType, ReceivedRepresentingEmailAddress, ReceivedRepresentingEntryId, ReceivedRepresentingName, ReceivedRepresentingSearchKey, ReceivedRepresentingSmtpAddress, RecipientDisplayName, RecipientEntryId, RecipientFlags, RecipientOrder, RecipientProposed, RecipientProposedEndTime, RecipientProposedStartTime, RecipientReassignmentProhibited, RecipientTrackStatus, RecipientTrackStatusTime, RecipientType, RecordKey, ReferredByName, RemindersOnlineEntryId, RemoteMessageTransferAgent, RenderingPosition, ReplyRecipientEntries, ReplyRecipientNames, ReplyRequested, ReplyTemplateId, ReplyTime, ReportDisposition, ReportDispositionMode, ReportEntryId, ReportingMessageTransferAgent, ReportName, ReportSearchKey, ReportTag, ReportText, ReportTime, ResolveMethod, ResponseRequested, Responsibility, RetentionDate, RetentionFlags, RetentionPeriod, Rights, RoamingDatatypes, RoamingDictionary, RoamingXmlStream, Rowid, RowType, RtfCompressed, RtfInSync, RuleActionNumber, RuleActions, RuleActionType, RuleCondition, RuleError, RuleFolderEntryId, RuleId, RuleIds, RuleLevel, RuleMessageLevel, RuleMessageName, RuleMessageProvider, RuleMessageProviderData, RuleMessageSequence, RuleMessageState, RuleMessageUserFlags, RuleName, RuleProvider, RuleProviderData, RuleSequence, RuleState, RuleUserFlags, RwRulesStream, ScheduleInfoAppointmentTombstone, ScheduleInfoAutoAcceptAppointments, ScheduleInfoDelegateEntryIds, ScheduleInfoDelegateNames, ScheduleInfoDelegateNamesW, ScheduleInfoDelegatorWantsCopy, ScheduleInfoDelegatorWantsInfo, ScheduleInfoDisallowOverlappingAppts, ScheduleInfoDisallowRecurringAppts, ScheduleInfoDontMailDelegates, ScheduleInfoFreeBusy, ScheduleInfoFreeBusyAway, ScheduleInfoFreeBusyBusy, ScheduleInfoFreeBusyMerged, ScheduleInfoFreeBusyTentative, ScheduleInfoMonthsAway, ScheduleInfoMonthsBusy, ScheduleInfoMonthsMerged, ScheduleInfoMonthsTentative, ScheduleInfoResourceType, SchedulePlusFreeBusyEntryId, ScriptData, SearchFolderDefinition, SearchFolderEfpFlags, SearchFolderExpiration, SearchFolderId, SearchFolderLastUsed, SearchFolderRecreateInfo, SearchFolderStorageType, SearchFolderTag, SearchFolderTemplateId, SearchKey, SecurityDescriptorAsXml, Selectable, SenderAddressType, SenderEmailAddress, SenderEntryId, SenderIdStatus, SenderName, SenderSearchKey, SenderSmtpAddress, SenderTelephoneNumber, SendInternetEncoding, SendRichInfo, Sensitivity, SentMailSvrEID, SentRepresentingAddressType, SentRepresentingEmailAddress, SentRepresentingEntryId, SentRepresentingFlags, SentRepresentingName, SentRepresentingSearchKey, SentRepresentingSmtpAddress, SmtpAddress, SortLocaleId, SourceKey, SpokenName, SpouseName, StartDate, StartDateEtc, StateOrProvince, StoreEntryId, StoreState, StoreSupportMask, StreetAddress, Subfolders, TagSubject, SubjectPrefix, SupplementaryInfo, Surname, SwappedToDoData, SwappedToDoStore, TargetEntryId, TelecommunicationsDeviceForDeafTelephoneNumber, TelexNumber, TemplateData, Templateid, TextAttachmentCharset, ThumbnailPhoto, TagTitle, TnefCorrelationKey, ToDoItemFlags, TransmittableDisplayName, TransportMessageHeaders, TrustSender, UserCertificate, UserEntryId, UserX509Certificate, ViewDescriptorBinary, ViewDescriptorName, ViewDescriptorStrings, ViewDescriptorVersion, VoiceMessageAttachmentOrder, VoiceMessageDuration, VoiceMessageSenderName, WeddingAnniversary, WlinkAddressBookEID, WlinkAddressBookStoreEID, WlinkCalendarColor, WlinkClientID, WlinkEntryId, WlinkFlags, WlinkFolderType, WlinkGroupClsid, WlinkGroupHeaderID, WlinkGroupName, WlinkOrdinal, WlinkRecordKey, WlinkROGroupType, WlinkSaveStamp, WlinkSection, WlinkStoreEntryId, WlinkType, Abstract, ActiveUserEntryid, AddrbookForLocalSiteEntryid, AddressBookDisplayName, ArrivalTime, AssocMessageSize, AssocMessageSizeExtended, AssocMsgWAttachCount, AttachOnAssocMsgCount, AttachOnNormalMsgCount, AutoAddNewSubs, BilateralInfo, CachedColumnCount, CategCount, ChangeAdvisor, ChangeNotificationGuid, Collector, ContactCount, ContentSearchKey, ContentsSynchronizer, DeletedAssocMessageSizeExtended, DeletedAssocMsgCount, DeletedFolderCount, DeletedMessageSizeExtended, DeletedMsgCount, DeletedNormalMessageSizeExtended, DesignInProgress, DisableFullFidelity, DisableWinsock, DlReportFlags, EformsForLocaleEntryid, EformsLocaleId, EformsRegistryEntryid, EmsAbAccessCategory, EmsAbActivationSchedule, EmsAbActivationStyle, EmsAbAddressEntryDisplayTable, EmsAbAddressEntryDisplayTableMsdos, EmsAbAddressSyntax, EmsAbAddressType, EmsAbAdmd, EmsAbAdminDescription, EmsAbAdminDisplayName, EmsAbAdminExtensionDll, EmsAbAliasedObjectName, EmsAbAliasedObjectNameO, EmsAbAltRecipient, EmsAbAltRecipientBl, EmsAbAltRecipientBlO, EmsAbAltRecipientO, EmsAbAncestorId, EmsAbAnonymousAccess, EmsAbAnonymousAccount, EmsAbAssocNtAccount, EmsAbAssocProtocolCfgNntp, EmsAbAssocProtocolCfgNntpO, EmsAbAssocRemoteDxa, EmsAbAssocRemoteDxaO, EmsAbAssociationLifetime, EmsAbAttributeCertificate, EmsAbAuthOrigBl, EmsAbAuthOrigBlO, EmsAbAuthenticationToUse, EmsAbAuthorityRevocationList, EmsAbAuthorizedDomain, EmsAbAuthorizedPassword, EmsAbAuthorizedPasswordConfirm, EmsAbAuthorizedUser, EmsAbAutoreply, EmsAbAutoreplyMessage, EmsAbAutoreplySubject, EmsAbAvailableAuthorizationPackages, EmsAbAvailableDistributions, EmsAbBridgeheadServers, EmsAbBridgeheadServersO, EmsAbBusinessCategory, EmsAbBusinessRoles, EmsAbCaCertificate, EmsAbCanCreatePf, EmsAbCanCreatePfBl, EmsAbCanCreatePfBlO, EmsAbCanCreatePfDl, EmsAbCanCreatePfDlBl, EmsAbCanCreatePfDlBlO, EmsAbCanCreatePfDlO, EmsAbCanCreatePfO, EmsAbCanNotCreatePf, EmsAbCanNotCreatePfBl, EmsAbCanNotCreatePfBlO, EmsAbCanNotCreatePfDl, EmsAbCanNotCreatePfDlBl, EmsAbCanNotCreatePfDlBlO, EmsAbCanNotCreatePfDlO, EmsAbCanNotCreatePfO, EmsAbCanPreserveDns, EmsAbCertificateChainV3, EmsAbCertificateRevocationList, EmsAbCertificateRevocationListV1, EmsAbCertificateRevocationListV3, EmsAbCharacterSet, EmsAbCharacterSetList, EmsAbChildRdns, EmsAbClientAccessEnabled, EmsAbClockAlertOffset, EmsAbClockAlertRepair, EmsAbClockWarningOffset, EmsAbClockWarningRepair, EmsAbCompromisedKeyList, EmsAbComputerName, EmsAbConnectedDomains, EmsAbConnectionListFilter, EmsAbConnectionListFilterType, EmsAbConnectionType, EmsAbContainerInfo, EmsAbContentType, EmsAbControlMsgFolderId, EmsAbControlMsgRules, EmsAbCost, EmsAbCountryName, EmsAbCrossCertificateCrl, EmsAbCrossCertificatePair, EmsAbDefaultMessageFormat, EmsAbDelegateUser, EmsAbDelivEits, EmsAbDelivExtContTypes, EmsAbDeliverAndRedirect, EmsAbDeliveryMechanism, EmsAbDeltaRevocationList, EmsAbDescription, EmsAbDestinationIndicator, EmsAbDiagnosticRegKey, EmsAbDisableDeferredCommit, EmsAbDisabledGatewayProxy, EmsAbDisplayNameOverride, EmsAbDisplayNameSuffix, EmsAbDlMemRejectPermsBl, EmsAbDlMemRejectPermsBlO, EmsAbDlMemberRule, EmsAbDmdName, EmsAbDoOabVersion, EmsAbDomainDefAltRecip, EmsAbDomainDefAltRecipO, EmsAbDomainName, EmsAbDsaSignature, EmsAbDxaAdminCopy, EmsAbDxaAdminForward, EmsAbDxaAdminUpdate, EmsAbDxaAppendReqcn, EmsAbDxaConfContainerList, EmsAbDxaConfContainerListO, EmsAbDxaConfReqTime, EmsAbDxaConfSeq, EmsAbDxaConfSeqUsn, EmsAbDxaExchangeOptions, EmsAbDxaExportNow, EmsAbDxaFlags, EmsAbDxaImpSeq, EmsAbDxaImpSeqTime, EmsAbDxaImpSeqUsn, EmsAbDxaImportNow, EmsAbDxaInTemplateMap, EmsAbDxaLocalAdmin, EmsAbDxaLocalAdminO, EmsAbDxaLoggingLevel, EmsAbDxaNativeAddressType, EmsAbDxaOutTemplateMap, EmsAbDxaPassword, EmsAbDxaPrevExchangeOptions, EmsAbDxaPrevExportNativeOnly, EmsAbDxaPrevInExchangeSensitivity, EmsAbDxaPrevRemoteEntries, EmsAbDxaPrevRemoteEntriesO, EmsAbDxaPrevReplicationSensitivity, EmsAbDxaPrevTemplateOptions, EmsAbDxaPrevTypes, EmsAbDxaRecipientCp, EmsAbDxaRemoteClient, EmsAbDxaRemoteClientO, EmsAbDxaReqSeq, EmsAbDxaReqSeqTime, EmsAbDxaReqSeqUsn, EmsAbDxaReqname, EmsAbDxaSvrSeq, EmsAbDxaSvrSeqTime, EmsAbDxaSvrSeqUsn, EmsAbDxaTask, EmsAbDxaTemplateOptions, EmsAbDxaTemplateTimestamp, EmsAbDxaTypes, EmsAbDxaUnconfContainerList, EmsAbDxaUnconfContainerListO, EmsAbEmployeeNumber, EmsAbEmployeeType, EmsAbEnableCompatibility, EmsAbEnabled, EmsAbEnabledAuthorizationPackages, EmsAbEnabledProtocolCfg, EmsAbEnabledProtocols, EmsAbEncapsulationMethod, EmsAbEncrypt, EmsAbEncryptAlgListNa, EmsAbEncryptAlgListOther, EmsAbEncryptAlgSelectedNa, EmsAbEncryptAlgSelectedOther, EmsAbExpandDlsLocally, EmsAbExpirationTime, EmsAbExportContainers, EmsAbExportContainersO, EmsAbExportCustomRecipients, EmsAbExtendedCharsAllowed, EmsAbExtensionData, EmsAbExtensionName, EmsAbExtensionNameInherited, EmsAbFacsimileTelephoneNumber, EmsAbFileVersion, EmsAbFilterLocalAddresses, EmsAbFoldersContainer, EmsAbFoldersContainerO, EmsAbFormData, EmsAbForwardingAddress, EmsAbGarbageCollPeriod, EmsAbGatewayLocalCred, EmsAbGatewayLocalDesig, EmsAbGatewayProxy, EmsAbGatewayRoutingTree, EmsAbGenerationQualifier, EmsAbGroupByAttr1, EmsAbGroupByAttr2, EmsAbGroupByAttr3, EmsAbGroupByAttr4, EmsAbGroupByAttrValueDn, EmsAbGroupByAttrValueDnO, EmsAbGroupByAttrValueStr, EmsAbGwartLastModified, EmsAbHasFullReplicaNcs, EmsAbHasFullReplicaNcsO, EmsAbHasMasterNcs, EmsAbHasMasterNcsO, EmsAbHelpData16, EmsAbHelpData32, EmsAbHelpFileName, EmsAbHeuristics, EmsAbHideDlMembership, EmsAbHideFromAddressBook, EmsAbHierarchyPath, EmsAbHomeMdbBl, EmsAbHomeMdbBlO, EmsAbHomeMta, EmsAbHomeMtaO, EmsAbHomePublicServer, EmsAbHomePublicServerO, EmsAbHouseIdentifier, EmsAbHttpPubAbAttributes, EmsAbHttpPubGal, EmsAbHttpPubGalLimit, EmsAbHttpPubPf, EmsAbHttpServers, EmsAbImportContainer, EmsAbImportContainerO, EmsAbImportSensitivity, EmsAbImportedFrom, EmsAbInboundAcceptAll, EmsAbInboundDn, EmsAbInboundDnO, EmsAbInboundHost, EmsAbInboundNewsfeed, EmsAbInboundNewsfeedType, EmsAbInboundSites, EmsAbInboundSitesO, EmsAbIncomingMsgSizeLimit, EmsAbIncomingPassword, EmsAbInsadmin, EmsAbInsadminO, EmsAbInstanceType, EmsAbInternationalIsdnNumber, EmsAbInvocationId, EmsAbIsDeleted, EmsAbIsSingleValued, EmsAbKccStatus, EmsAbKmServer, EmsAbKmServerO, EmsAbKnowledgeInformation, EmsAbLabeleduri, EmsAbLanguage, EmsAbLanguageIso639, EmsAbLdapDisplayName, EmsAbLdapSearchCfg, EmsAbLineWrap, EmsAbLinkId, EmsAbListPublicFolders, EmsAbLocalBridgeHead, EmsAbLocalBridgeHeadAddress, EmsAbLocalInitialTurn, EmsAbLocalScope, EmsAbLocalScopeO, EmsAbLogFilename, EmsAbLogRolloverInterval, EmsAbMailDrop, EmsAbMaintainAutoreplyHistory, EmsAbMapiDisplayType, EmsAbMapiId, EmsAbMaximumObjectId, EmsAbMdbBackoffInterval, EmsAbMdbMsgTimeOutPeriod, EmsAbMdbOverQuotaLimit, EmsAbMdbStorageQuota, EmsAbMdbUnreadLimit, EmsAbMdbUseDefaults, EmsAbMessageTrackingEnabled, EmsAbMimeTypes, EmsAbModerated, EmsAbModerator, EmsAbMonitorClock, EmsAbMonitorServers, EmsAbMonitorServices, EmsAbMonitoredConfigurations, EmsAbMonitoredConfigurationsO, EmsAbMonitoredServers, EmsAbMonitoredServersO, EmsAbMonitoredServices, EmsAbMonitoringAlertDelay, EmsAbMonitoringAlertUnits, EmsAbMonitoringAvailabilityStyle, EmsAbMonitoringAvailabilityWindow, EmsAbMonitoringCachedViaMail, EmsAbMonitoringCachedViaMailO, EmsAbMonitoringCachedViaRpc, EmsAbMonitoringCachedViaRpcO, EmsAbMonitoringEscalationProcedure, EmsAbMonitoringHotsitePollInterval, EmsAbMonitoringHotsitePollUnits, EmsAbMonitoringMailUpdateInterval, EmsAbMonitoringMailUpdateUnits, EmsAbMonitoringNormalPollInterval, EmsAbMonitoringNormalPollUnits, EmsAbMonitoringRecipients, EmsAbMonitoringRecipientsNdr, EmsAbMonitoringRecipientsNdrO, EmsAbMonitoringRecipientsO, EmsAbMonitoringRpcUpdateInterval, EmsAbMonitoringRpcUpdateUnits, EmsAbMonitoringWarningDelay, EmsAbMonitoringWarningUnits, EmsAbMtaLocalCred, EmsAbMtaLocalDesig, EmsAbNAddress, EmsAbNAddressType, EmsAbNewsfeedType, EmsAbNewsgroup, EmsAbNewsgroupList, EmsAbNntpCharacterSet, EmsAbNntpContentFormat, EmsAbNntpDistributions, EmsAbNntpDistributionsFlag, EmsAbNntpNewsfeeds, EmsAbNntpNewsfeedsO, EmsAbNtMachineName, EmsAbNtSecurityDescriptor, EmsAbNumOfOpenRetries, EmsAbNumOfTransferRetries, EmsAbObjViewContainers, EmsAbObjViewContainersO, EmsAbObjectClassCategory, EmsAbObjectOid, EmsAbObjectVersion, EmsAbOffLineAbContainers, EmsAbOffLineAbContainersO, EmsAbOffLineAbSchedule, EmsAbOffLineAbServer, EmsAbOffLineAbServerO, EmsAbOffLineAbStyle, EmsAbOidType, EmsAbOmObjectClass, EmsAbOmSyntax, EmsAbOofReplyToOriginator, EmsAbOpenRetryInterval, EmsAbOrganizationName, EmsAbOrganizationalUnitName, EmsAbOriginalDisplayTable, EmsAbOriginalDisplayTableMsdos, EmsAbOtherRecips, EmsAbOutboundHost, EmsAbOutboundHostType, EmsAbOutboundNewsfeed, EmsAbOutboundSites, EmsAbOutboundSitesO, EmsAbOutgoingMsgSizeLimit, EmsAbOverrideNntpContentFormat, EmsAbOwaServer, EmsAbPSelector, EmsAbPSelectorInbound, EmsAbPerMsgDialogDisplayTable, EmsAbPerRecipDialogDisplayTable, EmsAbPeriodRepSyncTimes, EmsAbPeriodReplStagger, EmsAbPersonalTitle, EmsAbPfContacts, EmsAbPfContactsO, EmsAbPopCharacterSet, EmsAbPopContentFormat, EmsAbPortNumber, EmsAbPostalAddress, EmsAbPreferredDeliveryMethod, EmsAbPreserveInternetContent, EmsAbPrmd, EmsAbPromoExpiration, EmsAbProtocolSettings, EmsAbProxyGenerationEnabled, EmsAbProxyGeneratorDll, EmsAbPublicDelegatesBl, EmsAbPublicDelegatesBlO, EmsAbQuotaNotificationSchedule, EmsAbQuotaNotificationStyle, EmsAbRangeLower, EmsAbRangeUpper, EmsAbRasAccount, EmsAbRasCallbackNumber, EmsAbRasPassword, EmsAbRasPhoneNumber, EmsAbRasPhonebookEntryName, EmsAbRasRemoteSrvrName, EmsAbReferralList, EmsAbRegisteredAddress, EmsAbRemoteBridgeHead, EmsAbRemoteBridgeHeadAddress, EmsAbRemoteOutBhServer, EmsAbRemoteOutBhServerO, EmsAbRemoteSite, EmsAbRemoteSiteO, EmsAbReplicatedObjectVersion, EmsAbReplicationMailMsgSize, EmsAbReplicationSensitivity, EmsAbReplicationStagger, EmsAbReportToOriginator, EmsAbReportToOwner, EmsAbReqSeq, EmsAbRequireSsl, EmsAbResponsibleLocalDxa, EmsAbResponsibleLocalDxaO, EmsAbReturnExactMsgSize, EmsAbRidServer, EmsAbRidServerO, EmsAbRoleOccupant, EmsAbRoleOccupantO, EmsAbRootNewsgroupsFolderId, EmsAbRoutingList, EmsAbRtsCheckpointSize, EmsAbRtsRecoveryTimeout, EmsAbRtsWindowSize, EmsAbRunsOn, EmsAbRunsOnO, EmsAbSSelector, EmsAbSSelectorInbound, EmsAbSchemaFlags, EmsAbSchemaVersion, EmsAbSearchFlags, EmsAbSearchGuide, EmsAbSecurityPolicy, EmsAbSecurityProtocol, EmsAbSeeAlso, EmsAbSeeAlsoO, EmsAbSendEmailMessage, EmsAbSendTnef, EmsAbSerialNumber, EmsAbServer, EmsAbServiceActionFirst, EmsAbServiceActionOther, EmsAbServiceActionSecond, EmsAbServiceRestartDelay, EmsAbServiceRestartMessage, EmsAbSessionDisconnectTimer, EmsAbSiteAffinity, EmsAbSiteFolderGuid, EmsAbSiteFolderServer, EmsAbSiteFolderServerO, EmsAbSiteProxySpace, EmsAbSmimeAlgListNa, EmsAbSmimeAlgListOther, EmsAbSmimeAlgSelectedNa, EmsAbSmimeAlgSelectedOther, EmsAbSpaceLastComputed, EmsAbStreetAddress, EmsAbSubRefs, EmsAbSubRefsO, EmsAbSubSite, EmsAbSubmissionContLength, EmsAbSupportSmimeSignatures, EmsAbSupportedAlgorithms, EmsAbSupportedApplicationContext, EmsAbSupportingStack, EmsAbSupportingStackBl, EmsAbSupportingStackBlO, EmsAbSupportingStackO, EmsAbTSelector, EmsAbTSelectorInbound, EmsAbTargetMtas, EmsAbTelephoneNumber, EmsAbTelephonePersonalPager, EmsAbTeletexTerminalIdentifier, EmsAbTempAssocThreshold, EmsAbTombstoneLifetime, EmsAbTrackingLogPathName, EmsAbTransRetryMins, EmsAbTransTimeoutMins, EmsAbTransferRetryInterval, EmsAbTransferTimeoutNonUrgent, EmsAbTransferTimeoutNormal, EmsAbTransferTimeoutUrgent, EmsAbTranslationTableUsed, EmsAbTransportExpeditedData, EmsAbTrustLevel, EmsAbTurnRequestThreshold, EmsAbTwoWayAlternateFacility, EmsAbType, EmsAbUnauthOrigBl, EmsAbUnauthOrigBlO, EmsAbUseServerValues, EmsAbUseSiteValues, EmsAbUsenetSiteName, EmsAbUserPassword, EmsAbUsnChanged, EmsAbUsnCreated, EmsAbUsnDsaLastObjRemoved, EmsAbUsnIntersite, EmsAbUsnLastObjRem, EmsAbUsnSource, EmsAbViewContainer1, EmsAbViewContainer2, EmsAbViewContainer3, EmsAbViewDefinition, EmsAbViewFlags, EmsAbViewSite, EmsAbVoiceMailFlags, EmsAbVoiceMailGreetings, EmsAbVoiceMailPassword, EmsAbVoiceMailRecordedName, EmsAbVoiceMailRecordingLength, EmsAbVoiceMailSpeed, EmsAbVoiceMailSystemGuid, EmsAbVoiceMailUserId, EmsAbVoiceMailVolume, EmsAbWwwHomePage, EmsAbX121Address, EmsAbX25CallUserDataIncoming, EmsAbX25CallUserDataOutgoing, EmsAbX25FacilitiesDataIncoming, EmsAbX25FacilitiesDataOutgoing, EmsAbX25LeasedLinePort, EmsAbX25LeasedOrSwitched, EmsAbX25RemoteMtaPhone, EmsAbX400AttachmentType, EmsAbX400SelectorSyntax, EmsAbX500AccessControlList, EmsAbX500Nc, EmsAbX500Rdn, EmsAbXmitTimeoutNonUrgent, EmsAbXmitTimeoutNormal, EmsAbXmitTimeoutUrgent, EventsRootFolderEntryid, ExcessStorageUsed, ExtendedAclData, FastTransfer, FavoritesDefaultName, FolderChildCount, FolderDesignFlags, FolderPathname, ForeignId, ForeignReportId, ForeignSubjectId, FreeBusyForLocalSiteEntryid, GwAdminOperations, GwMtsinEntryid, GwMtsoutEntryid, HasModeratorRules, HierarchyServer, HierarchySynchronizer, ImapInternalDate, InTransit, InboundNewsfeedDn, InternetCharset, InternetNewsgroupName, IpmDafEntryid, IpmFavoritesEntryid, IpmPublicFoldersEntryid, IsNewsgroup, IsNewsgroupAnchor, LastAccessTime, LastFullBackup, LastLogoffTime, LastLogonTime, LongtermEntryidFromTable, MessageProcessed, MessageSiteName, MoveToFolderEntryid, MoveToStoreEntryid, MsgBodyId, MtsSubjectId, NewSubsGetAutoAdd, NewsfeedInfo, NewsgroupComponent, NewsgroupRootFolderEntryid, NntpArticleFolderEntryid, NntpControlFolderEntryid, NonIpmSubtreeEntryid, NormalMessageSize, NormalMessageSizeExtended, NormalMsgWAttachCount, NtUserName, OfflineAddrbookEntryid, OfflineFlags, OfflineMessageEntryid, OldestDeletedOn, OriginatorAddr, OriginatorAddrtype, OriginatorEntryid, OriginatorName, OstEncryption, OutboundNewsfeedDn, OverallAgeLimit, OverallMsgAgeLimit, OwaUrl, OwnerCount, P1Content, P1ContentType, PreventMsgCreate, Preview, PreviewUnread, ProfileAbFilesPath, ProfileAddrInfo, ProfileAllpubComment, ProfileAllpubDisplayName, ProfileBindingOrder, ProfileConfigFlags, ProfileConnectFlags, ProfileFavfldComment, ProfileFavfldDisplayName, ProfileHomeServer, ProfileHomeServerAddrs, ProfileHomeServerDn, ProfileMailbox, ProfileMaxRestrict, ProfileMoab, ProfileMoabGuid, ProfileMoabSeq, ProfileOfflineInfo, ProfileOfflineStorePath, ProfileOpenFlags, ProfileOptionsData, ProfileSecureMailbox, ProfileServer, ProfileServerDn, ProfileTransportFlags, ProfileType, ProfileUiState, ProfileUnresolvedName, ProfileUnresolvedServer, ProfileUser, ProfileVersion, PstEncryption, PstPath, PstPwSzOld, PstRememberPw, PublicFolderEntryid, PublishInAddressBook, RecipientNumber, RecipientOnAssocMsgCount, RecipientOnNormalMsgCount, ReplicaList, ReplicaServer, ReplicaVersion, ReplicationAlwaysInterval, ReplicationMessagePriority, ReplicationMsgSize, ReplicationSchedule, ReplicationStyle, ReplyRecipientSmtpProxies, ReportDestinationEntryid, ReportDestinationName, RestrictionCount, RetentionAgeLimit, RuleTriggerHistory, RulesData, RulesTable, ScheduleFolderEntryid, SecureInSite, SecureOrigination, StorageLimitInformation, StorageQuotaLimit, StoreOffline, StoreSlowlink, SubjectTraceInfo, SvrGeneratingQuotaMsg, SynchronizeFlags, SysConfigFolderEntryid, TestLineSpeed, TraceInfo, TransferEnabled, UserName, X400EnvelopeType, AbDefaultDir, AbDefaultPab, AbProviderId, AbProviders, AbSearchPath, AbSearchPathUpdate, AlternateRecipient, AssocContentCount, AttachmentX400Parameters, AuthorizingUsers, BodyCrc, CommonViewsEntryid, ContactAddrtypes, ContactDefaultAddressIndex, ContactEmailAddresses, ContactEntryids, ContactVersion, ContainerModifyVersion, ContentConfidentialityAlgorithmId, ContentCorrelator, ContentIdentifier, ContentIntegrityCheck, ContentLength, ContentReturnRequested, ContentsSortOrder, ControlFlags, ControlId, ControlStructure, ControlType, ConversationKey, ConversionEits, ConversionProhibited, ConversionWithLossProhibited, ConvertedEits, Correlate, CorrelateMtsid, CreateTemplates, CreationVersion, ExCurrentVersion, DefCreateDl, DefCreateMailuser, DefaultProfile, DefaultStore, DefaultViewEntryid, Delegation, DeliveryPoint, Deltax, Deltay, DetailsTable, DiscVal, DiscardReason, DiscloseRecipients, DisclosureOfRecipients, DiscreteValues, DlExpansionHistory, DlExpansionProhibited, ExplicitConversion, FilteringHooks, FinderEntryid, FormCategory, FormCategorySub, FormClsid, FormContactName, FormDesignerGuid, FormDesignerName, FormHidden, FormHostMap, FormMessageBehavior, FormVersion, HeaderFolderEntryid, Icon, IdentityDisplay, IdentityEntryid, IdentitySearchKey, ImplicitConversionProhibited, IncompleteCopy, InternetApproved, InternetArticleNumber, InternetControl, InternetDistribution, InternetFollowupTo, InternetLines, InternetNewsgroups, InternetNntpPath, InternetOrganization, InternetPrecedence, IpmId, IpmOutboxEntryid, IpmOutboxSearchKey, IpmReturnRequested, IpmSentmailEntryid, IpmSentmailSearchKey, IpmSubtreeEntryid, IpmSubtreeSearchKey, IpmWastebasketEntryid, IpmWastebasketSearchKey, Languages, LatestDeliveryTime, MailPermission, MdbProvider, MessageDeliveryId, MessageDownloadTime, MessageSecurityLabel, MessageToken, MiniIcon, ModifyVersion, NewsgroupName, NntpXref, NonReceiptReason, ObsoletedIpms, OriginCheck, OriginalAuthorAddrtype, OriginalAuthorEmailAddress, OriginalAuthorSearchKey, OriginalDisplayName, OriginalEits, OriginalSearchKey, OriginallyIntendedRecipAddrtype, OriginallyIntendedRecipEmailAddress, OriginallyIntendedRecipEntryid, OriginallyIntendedRecipientName, OriginatingMtaCertificate, OriginatorAndDlExpansionHistory, OriginatorCertificate, OriginatorRequestedAlternateRecipient, OriginatorReturnAddress, OwnStoreEntryid, ParentDisplay, PhysicalDeliveryBureauFaxDelivery, PhysicalDeliveryMode, PhysicalDeliveryReportRequest, PhysicalForwardingAddress, PhysicalForwardingAddressRequested, PhysicalForwardingProhibited, PhysicalRenditionAttributes, PostFolderEntries, PostFolderNames, PostReplyDenied, PostReplyFolderEntries, PostReplyFolderNames, Preprocess, PrimaryCapability, ProfileName, ProofOfDelivery, ProofOfDeliveryRequested, ProofOfSubmission, ProofOfSubmissionRequested, ProviderDisplay, ProviderDllName, ProviderOrdinal, ProviderSubmitTime, ProviderUid, ReceiveFolderSettings, RecipientCertificate, RecipientNumberForAdvice, RecipientStatus, RedirectionHistory, RegisteredMailType, RelatedIpms, RemoteProgress, RemoteProgressText, RemoteValidateOk, ReportingDlName, ReportingMtaCertificate, RequestedDeliveryMethod, ResourceFlags, ResourceMethods, ResourcePath, ResourceType, ReturnedIpm, RtfSyncBodyCount, RtfSyncBodyCrc, RtfSyncBodyTag, RtfSyncPrefixCount, RtfSyncTrailingCount, Search, ExSecurity, SentmailEntryid, ServiceDeleteFiles, ServiceDllName, ServiceEntryName, ServiceExtraUids, ServiceName, ServiceSupportFiles, ServiceUid, Services, SpoolerStatus, Status, StatusCode, StatusString, StoreProviders, StoreRecordKey, SubjectIpm, SubmitFlags, Supersedes, TransportKey, TransportProviders, TransportStatus, TypeOfMtsUser, ValidFolderMask, ViewsEntryid, X400ContentType, X400DeferredDeliveryCancel, Xpos, Ypos | +**name** |**str** |Known property name. See all known properties here: https://apireference.aspose.com/email/net/aspose.email.mapi/knownpropertylist/fields/index Possible values: Mileage, ObjectUri, GDataContactVersion, GDataPhotoVersion, AddressBookProviderArrayType, AddressBookProviderEmailList, AddressCountryCode, AgingDontAgeMe, AllAttendeesString, AllowExternalCheck, AnniversaryEventEntryId, AppointmentAuxiliaryFlags, AppointmentColor, AppointmentCounterProposal, AppointmentDuration, AppointmentEndDate, AppointmentEndTime, AppointmentEndWhole, AppointmentLastSequence, AppointmentMessageClass, AppointmentNotAllowPropose, AppointmentProposalNumber, AppointmentProposedDuration, AppointmentProposedEndWhole, AppointmentProposedStartWhole, AppointmentRecur, AppointmentReplyName, AppointmentReplyTime, AppointmentSequence, AppointmentSequenceTime, AppointmentStartDate, AppointmentStartTime, AppointmentStartWhole, AppointmentStateFlags, AppointmentSubType, AppointmentTimeZoneDefinitionEndDisplay, AppointmentTimeZoneDefinitionRecur, AppointmentTimeZoneDefinitionStartDisplay, AppointmentUnsendableRecipients, AppointmentUpdateTime, AttendeeCriticalChange, AutoFillLocation, AutoLog, AutoProcessState, AutoStartCheck, Billing, BirthdayEventEntryId, BirthdayLocal, BusinessCardCardPicture, BusinessCardDisplayDefinition, BusyStatus, CalendarType, Categories, CcAttendeesString, ChangeHighlight, Classification, ClassificationDescription, ClassificationGuid, ClassificationKeep, Classified, CleanGlobalObjectId, ClientIntent, ClipEnd, ClipStart, CollaborateDoc, CommonEnd, CommonStart, Companies, ConferencingCheck, ConferencingType, ContactCharacterSet, ContactItemData, ContactLinkedGlobalAddressListEntryId, ContactLinkEntry, ContactLinkGlobalAddressListLinkId, ContactLinkGlobalAddressListLinkState, ContactLinkLinkRejectHistory, ContactLinkName, ContactLinkSearchKey, ContactLinkSMTPAddressCache, Contacts, ContactUserField1, ContactUserField2, ContactUserField3, ContactUserField4, ConversationActionLastAppliedTime, ConversationActionMaxDeliveryTime, ConversationActionMoveFolderEid, ConversationActionMoveStoreEid, ConversationActionVersion, ConversationProcessed, CurrentVersion, CurrentVersionName, DayInterval, DayOfMonth, DelegateMail, Department, Directory, DistributionListChecksum, DistributionListMembers, DistributionListName, DistributionListOneOffMembers, DistributionListStream, Email1AddressType, Email1DisplayName, Email1EmailAddress, Email1OriginalDisplayName, Email1OriginalEntryId, Email2AddressType, Email2DisplayName, Email2EmailAddress, Email2OriginalDisplayName, Email2OriginalEntryId, Email3AddressType, Email3DisplayName, Email3EmailAddress, Email3OriginalDisplayName, Email3OriginalEntryId, EndRecurrenceDate, EndRecurrenceTime, ExceptionReplaceTime, Fax1AddressType, Fax1EmailAddress, Fax1OriginalDisplayName, Fax1OriginalEntryId, Fax2AddressType, Fax2EmailAddress, Fax2OriginalDisplayName, Fax2OriginalEntryId, Fax3AddressType, Fax3EmailAddress, Fax3OriginalDisplayName, Fax3OriginalEntryId, FExceptionalAttendees, FExceptionalBody, FileUnder, FileUnderId, FileUnderList, FInvited, FlagRequest, FlagString, ForwardInstance, ForwardNotificationRecipients, FOthersAppointment, FreeBusyLocation, GlobalObjectId, HasPicture, HomeAddress, HomeAddressCountryCode, Html, ICalendarDayOfWeekMask, InboundICalStream, InfoPathFormName, InstantMessagingAddress, IntendedBusyStatus, InternetAccountName, InternetAccountStamp, IsContactLinked, IsException, IsRecurring, IsSilent, LinkedTaskItems, Location, LogDocumentPosted, LogDocumentPrinted, LogDocumentRouted, LogDocumentSaved, LogDuration, LogEnd, LogFlags, LogStart, LogType, LogTypeDesc, MeetingType, MeetingWorkspaceUrl, MonthInterval, MonthOfYear, MonthOfYearMask, NetShowUrl, NoEndDateFlag, NonSendableBcc, NonSendableCc, NonSendableTo, NonSendBccTrackStatus, NonSendCcTrackStatus, NonSendToTrackStatus, NoteColor, NoteHeight, NoteWidth, NoteX, NoteY, Occurrences, OldLocation, OldRecurrenceType, OldWhenEndWhole, OldWhenStartWhole, OnlinePassword, OptionalAttendees, OrganizerAlias, OriginalStoreEntryId, OtherAddress, OtherAddressCountryCode, OwnerCriticalChange, OwnerName, PendingStateForSiteMailboxDocument, PercentComplete, PostalAddressId, PostRssChannel, PostRssChannelLink, PostRssItemGuid, PostRssItemHash, PostRssItemLink, PostRssItemXml, PostRssSubscription, Private, PromptSendUpdate, RecurrenceDuration, RecurrencePattern, RecurrenceType, Recurring, ReferenceEntryId, ReminderDelta, ReminderFileParameter, ReminderOverride, ReminderPlaySound, ReminderSet, ReminderSignalTime, ReminderTime, ReminderTimeDate, ReminderTimeTime, ReminderType, RemoteStatus, RequiredAttendees, ResourceAttendees, ResponseStatus, ServerProcessed, ServerProcessingActions, SharingAnonymity, SharingBindingEntryId, SharingBrowseUrl, SharingCapabilities, SharingConfigurationUrl, SharingDataRangeEnd, SharingDataRangeStart, SharingDetail, SharingExtensionXml, SharingFilter, SharingFlags, SharingFlavor, SharingFolderEntryId, SharingIndexEntryId, SharingInitiatorEntryId, SharingInitiatorName, SharingInitiatorSmtp, SharingInstanceGuid, SharingLastAutoSyncTime, SharingLastSyncTime, SharingLocalComment, SharingLocalLastModificationTime, SharingLocalName, SharingLocalPath, SharingLocalStoreUid, SharingLocalType, SharingLocalUid, SharingOriginalMessageEntryId, SharingParentBindingEntryId, SharingParticipants, SharingPermissions, SharingProviderExtension, SharingProviderGuid, SharingProviderName, SharingProviderUrl, SharingRangeEnd, SharingRangeStart, SharingReciprocation, SharingRemoteByteSize, SharingRemoteComment, SharingRemoteCrc, SharingRemoteLastModificationTime, SharingRemoteMessageCount, SharingRemoteName, SharingRemotePass, SharingRemotePath, SharingRemoteStoreUid, SharingRemoteType, SharingRemoteUid, SharingRemoteUser, SharingRemoteVersion, SharingResponseTime, SharingResponseType, SharingRoamLog, SharingStart, SharingStatus, SharingStop, SharingSyncFlags, SharingSyncInterval, SharingTimeToLive, SharingTimeToLiveAuto, SharingWorkingHoursDays, SharingWorkingHoursEnd, SharingWorkingHoursStart, SharingWorkingHoursTimeZone, SideEffects, SingleBodyICal, SmartNoAttach, SpamOriginalFolder, StartRecurrenceDate, StartRecurrenceTime, TaskAcceptanceState, TaskAccepted, TaskActualEffort, TaskAssigner, TaskAssigners, TaskComplete, TaskCustomFlags, TaskDateCompleted, TaskDeadOccurrence, TaskDueDate, TaskEstimatedEffort, TaskFCreator, TaskFFixOffline, TaskFRecurring, TaskGlobalId, TaskHistory, TaskLastDelegate, TaskLastUpdate, TaskLastUser, TaskMode, TaskMultipleRecipients, TaskNoCompute, TaskOrdinal, TaskOwner, TaskOwnership, TaskRecurrence, TaskResetReminder, TaskRole, TaskStartDate, TaskState, TaskStatus, TaskStatusOnComplete, TaskUpdates, TaskVersion, TeamTask, TimeZone, TimeZoneDescription, TimeZoneStruct, ToAttendeesString, ToDoOrdinalDate, ToDoSubOrdinal, ToDoTitle, UseTnef, ValidFlagStringProof, VerbResponse, VerbStream, WeddingAnniversaryLocal, WeekInterval, Where, WorkAddress, WorkAddressCity, WorkAddressCountry, WorkAddressCountryCode, WorkAddressPostalCode, WorkAddressPostOfficeBox, WorkAddressState, WorkAddressStreet, YearInterval, YomiCompanyName, YomiFirstName, YomiLastName, AcceptLanguage, ApplicationName, AttachmentMacContentType, AttachmentMacInfo, AudioNotes, Author, AutomaticSpeechRecognitionData, ByteCount, CalendarAttendeeRole, CalendarBusystatus, CalendarContact, CalendarContactUrl, CalendarCreated, CalendarDescriptionUrl, CalendarDuration, CalendarExceptionDate, CalendarExceptionRule, CalendarGeoLatitude, CalendarGeoLongitude, CalendarInstanceType, CalendarIsOrganizer, CalendarLastModified, CalendarLocationUrl, CalendarMeetingStatus, CalendarMethod, CalendarProductId, CalendarRecurrenceIdRange, CalendarReminderOffset, CalendarResources, CalendarRsvp, CalendarSequence, CalendarTimeZone, CalendarTimeZoneId, CalendarTransparent, CalendarUid, CalendarVersion, Category, CharacterCount, Comments, Company, ContentBase, ContentClass, ContentType, CreateDateTimeReadOnly, CrossReference, DavId, DavIsCollection, DavIsStructuredDocument, DavParentName, DavUid, DocumentParts, EditTime, ExchangeIntendedBusyStatus, ExchangeJunkEmailMoveStamp, ExchangeModifyExceptionStructure, ExchangeNoModifyExceptions, ExchangePatternEnd, ExchangePatternStart, ExchangeReminderInterval, ExchDatabaseSchema, ExchDataExpectedContentClass, ExchDataSchemaCollectionReference, ExtractedAddresses, ExtractedContacts, ExtractedEmails, ExtractedMeetings, ExtractedPhones, ExtractedTasks, ExtractedUrls, From, HeadingPairs, HiddenCount, HttpmailCalendar, HttpmailHtmlDescription, HttpmailSendMessage, ICalendarRecurrenceDate, ICalendarRecurrenceRule, InternetSubject, Keywords, LastAuthor, LastPrinted, LastSaveDateTime, LineCount, LinksDirty, LocationUrl, Manager, MultimediaClipCount, NoteCount, OMSAccountGuid, OMSMobileModel, OMSScheduleTime, OMSServiceType, OMSSourceType, PageCount, ParagraphCount, PhishingStamp, PresentationFormat, QuarantineOriginalSender, RevisionNumber, RightsManagementLicense, Scale, Security, SlideCount, Subject, Template, Thumbnail, Title, WordCount, XCallId, XFaxNumberOfPages, XRequireProtectedPlayOnPhone, XSenderTelephoneNumber, XSharingBrowseUrl, XSharingCapabilities, XSharingConfigUrl, XSharingExendedCaps, XSharingFlavor, XSharingInstanceGuid, XSharingLocalType, XSharingProviderGuid, XSharingProviderName, XSharingProviderUrl, XSharingRemoteName, XSharingRemotePath, XSharingRemoteStoreUid, XSharingRemoteType, XSharingRemoteUid, XVoiceMessageAttachmentOrder, XVoiceMessageDuration, XVoiceMessageSenderName, Access, AccessControlListData, AccessLevel, Account, AdditionalRenEntryIds, AdditionalRenEntryIdsEx, AddressBookAuthorizedSenders, AddressBookContainerId, AddressBookDeliveryContentLength, AddressBookDisplayNamePrintable, AddressBookDisplayTypeExtended, AddressBookDistributionListExternalMemberCount, AddressBookDistributionListMemberCount, AddressBookDistributionListMemberSubmitAccepted, AddressBookDistributionListMemberSubmitRejected, AddressBookDistributionListRejectMessagesFromDLMembers, AddressBookEntryId, AddressBookExtensionAttribute1, AddressBookExtensionAttribute10, AddressBookExtensionAttribute11, AddressBookExtensionAttribute12, AddressBookExtensionAttribute13, AddressBookExtensionAttribute14, AddressBookExtensionAttribute15, AddressBookExtensionAttribute2, AddressBookExtensionAttribute3, AddressBookExtensionAttribute4, AddressBookExtensionAttribute5, AddressBookExtensionAttribute6, AddressBookExtensionAttribute7, AddressBookExtensionAttribute8, AddressBookExtensionAttribute9, AddressBookFolderPathname, AddressBookHierarchicalChildDepartments, AddressBookHierarchicalDepartmentMembers, AddressBookHierarchicalIsHierarchicalGroup, AddressBookHierarchicalParentDepartment, AddressBookHierarchicalRootDepartment, AddressBookHierarchicalShowInDepartments, AddressBookHomeMessageDatabase, AddressBookIsMaster, AddressBookIsMemberOfDistributionList, AddressBookManageDistributionList, AddressBookManager, AddressBookManagerDistinguishedName, AddressBookMember, AddressBookMessageId, AddressBookModerationEnabled, AddressBookNetworkAddress, AddressBookObjectDistinguishedName, AddressBookObjectGuid, AddressBookOrganizationalUnitRootDistinguishedName, AddressBookOwner, AddressBookOwnerBackLink, AddressBookParentEntryId, AddressBookPhoneticCompanyName, AddressBookPhoneticDepartmentName, AddressBookPhoneticDisplayName, AddressBookPhoneticGivenName, AddressBookPhoneticSurname, AddressBookProxyAddresses, AddressBookPublicDelegates, AddressBookReports, AddressBookRoomCapacity, AddressBookRoomContainers, AddressBookRoomDescription, AddressBookSenderHintTranslations, AddressBookSeniorityIndex, AddressBookTargetAddress, AddressBookUnauthorizedSenders, AddressBookX509Certificate, AddressType, AlternateRecipientAllowed, Anr, ArchiveDate, ArchivePeriod, ArchiveTag, Assistant, AssistantTelephoneNumber, Associated, AttachAdditionalInformation, AttachContentBase, AttachContentId, AttachContentLocation, AttachDataBinary, AttachDataObject, AttachEncoding, AttachExtension, AttachFilename, AttachFlags, AttachLongFilename, AttachLongPathname, AttachmentContactPhoto, AttachmentFlags, AttachmentHidden, AttachmentLinkId, AttachMethod, AttachMimeTag, AttachNumber, AttachPathname, AttachPayloadClass, AttachPayloadProviderGuidString, AttachRendering, AttachSize, AttachTag, AttachTransportName, AttributeHidden, AttributeReadOnly, AutoForwardComment, AutoForwarded, AutoResponseSuppress, Birthday, BlockStatus, Body, BodyContentId, BodyContentLocation, BodyHtml, Business2TelephoneNumber, Business2TelephoneNumbers, BusinessFaxNumber, BusinessHomePage, BusinessTelephoneNumber, CallbackTelephoneNumber, CallId, CarTelephoneNumber, CdoRecurrenceid, ChangeKey, ChangeNumber, ChildrensNames, ClientActions, ClientSubmitTime, CodePageId, Comment, CompanyMainTelephoneNumber, CompanyName, ComputerNetworkName, ConflictEntryId, ContainerClass, ContainerContents, ContainerFlags, ContainerHierarchy, ContentCount, ContentFilterSpamConfidenceLevel, ContentUnreadCount, ConversationId, ConversationIndex, ConversationIndexTracking, ConversationTopic, Country, CreationTime, CreatorEntryId, CreatorName, CustomerId, DamBackPatched, DamOriginalEntryId, DefaultPostMessageClass, DeferredActionMessageOriginalEntryId, DeferredDeliveryTime, DeferredSendNumber, DeferredSendTime, DeferredSendUnits, DelegatedByRule, DelegateFlags, DeleteAfterSubmit, DeletedCountTotal, DeletedOn, DeliverTime, DepartmentName, Depth, DisplayBcc, DisplayCc, DisplayName, DisplayNamePrefix, DisplayTo, DisplayType, DisplayTypeEx, EmailAddress, EndDate, EntryId, ExceptionEndTime, TagExceptionReplaceTime, ExceptionStartTime, ExchangeNTSecurityDescriptor, ExpiryNumber, ExpiryTime, ExpiryUnits, ExtendedFolderFlags, ExtendedRuleMessageActions, ExtendedRuleMessageCondition, ExtendedRuleSizeLimit, FaxNumberOfPages, FlagCompleteTime, FlagStatus, FlatUrlName, FolderAssociatedContents, FolderId, FolderFlags, FolderType, FollowupIcon, FreeBusyCountMonths, FreeBusyEntryIds, FreeBusyMessageEmailAddress, FreeBusyPublishEnd, FreeBusyPublishStart, FreeBusyRangeTimestamp, FtpSite, GatewayNeedsToRefresh, Gender, Generation, GivenName, GovernmentIdNumber, HasAttachments, HasDeferredActionMessages, HasNamedProperties, HasRules, HierarchyChangeNumber, HierRev, Hobbies, Home2TelephoneNumber, Home2TelephoneNumbers, HomeAddressCity, HomeAddressCountry, HomeAddressPostalCode, HomeAddressPostOfficeBox, HomeAddressStateOrProvince, HomeAddressStreet, HomeFaxNumber, HomeTelephoneNumber, TagHtml, ICalendarEndTime, ICalendarReminderNextTime, ICalendarStartTime, IconIndex, Importance, InConflict, InitialDetailsPane, Initials, InReplyToId, InstanceKey, InstanceNum, InstID, InternetCodepage, InternetMailOverrideFormat, InternetMessageId, InternetReferences, IpmAppointmentEntryId, IpmContactEntryId, IpmDraftsEntryId, IpmJournalEntryId, IpmNoteEntryId, IpmTaskEntryId, IsdnNumber, JunkAddRecipientsToSafeSendersList, JunkIncludeContacts, JunkPermanentlyDelete, JunkPhishingEnableLinks, JunkThreshold, Keyword, Language, LastModificationTime, LastModifierEntryId, LastModifierName, LastVerbExecuted, LastVerbExecutionTime, ListHelp, ListSubscribe, ListUnsubscribe, LocalCommitTime, LocalCommitTimeMax, LocaleId, Locality, TagLocation, MailboxOwnerEntryId, MailboxOwnerName, ManagerName, MappingSignature, MaximumSubmitMessageSize, MemberId, MemberName, MemberRights, MessageAttachments, MessageCcMe, MessageClass, MessageCodepage, MessageDeliveryTime, MessageEditorFormat, MessageFlags, MessageHandlingSystemCommonName, MessageLocaleId, MessageRecipientMe, MessageRecipients, MessageSize, MessageSizeExtended, MessageStatus, MessageSubmissionId, MessageToMe, Mid, MiddleName, MimeSkeleton, MobileTelephoneNumber, NativeBody, NextSendAcct, Nickname, NonDeliveryReportDiagCode, NonDeliveryReportReasonCode, NonDeliveryReportStatusCode, NonReceiptNotificationRequested, NormalizedSubject, ObjectType, OfficeLocation, OfflineAddressBookContainerGuid, OfflineAddressBookDistinguishedName, OfflineAddressBookMessageClass, OfflineAddressBookName, OfflineAddressBookSequence, OfflineAddressBookTruncatedProperties, OrdinalMost, OrganizationalIdNumber, OriginalAuthorEntryId, OriginalAuthorName, OriginalDeliveryTime, OriginalDisplayBcc, OriginalDisplayCc, OriginalDisplayTo, OriginalEntryId, OriginalMessageClass, OriginalMessageId, OriginalSenderAddressType, OriginalSenderEmailAddress, OriginalSenderEntryId, OriginalSenderName, OriginalSenderSearchKey, OriginalSensitivity, OriginalSentRepresentingAddressType, OriginalSentRepresentingEmailAddress, OriginalSentRepresentingEntryId, OriginalSentRepresentingName, OriginalSentRepresentingSearchKey, OriginalSubject, OriginalSubmitTime, OriginatorDeliveryReportRequested, OriginatorNonDeliveryReportRequested, OscSyncEnabled, OtherAddressCity, OtherAddressCountry, OtherAddressPostalCode, OtherAddressPostOfficeBox, OtherAddressStateOrProvince, OtherAddressStreet, OtherTelephoneNumber, OutOfOfficeState, OwnerAppointmentId, PagerTelephoneNumber, ParentEntryId, ParentFolderId, ParentKey, ParentSourceKey, PersonalHomePage, PolicyTag, PostalAddress, PostalCode, PostOfficeBox, PredecessorChangeList, PrimaryFaxNumber, PrimarySendAccount, PrimaryTelephoneNumber, Priority, Processed, Profession, ProhibitReceiveQuota, ProhibitSendQuota, PurportedSenderDomain, RadioTelephoneNumber, Read, ReadReceiptAddressType, ReadReceiptEmailAddress, ReadReceiptEntryId, ReadReceiptName, ReadReceiptRequested, ReadReceiptSearchKey, ReadReceiptSmtpAddress, ReceiptTime, ReceivedByAddressType, ReceivedByEmailAddress, ReceivedByEntryId, ReceivedByName, ReceivedBySearchKey, ReceivedBySmtpAddress, ReceivedRepresentingAddressType, ReceivedRepresentingEmailAddress, ReceivedRepresentingEntryId, ReceivedRepresentingName, ReceivedRepresentingSearchKey, ReceivedRepresentingSmtpAddress, RecipientDisplayName, RecipientEntryId, RecipientFlags, RecipientOrder, RecipientProposed, RecipientProposedEndTime, RecipientProposedStartTime, RecipientReassignmentProhibited, RecipientTrackStatus, RecipientTrackStatusTime, RecipientType, RecordKey, ReferredByName, RemindersOnlineEntryId, RemoteMessageTransferAgent, RenderingPosition, ReplyRecipientEntries, ReplyRecipientNames, ReplyRequested, ReplyTemplateId, ReplyTime, ReportDisposition, ReportDispositionMode, ReportEntryId, ReportingMessageTransferAgent, ReportName, ReportSearchKey, ReportTag, ReportText, ReportTime, ResolveMethod, ResponseRequested, Responsibility, RetentionDate, RetentionFlags, RetentionPeriod, Rights, RoamingDatatypes, RoamingDictionary, RoamingXmlStream, Rowid, RowType, RtfCompressed, RtfInSync, RuleActionNumber, RuleActions, RuleActionType, RuleCondition, RuleError, RuleFolderEntryId, RuleId, RuleIds, RuleLevel, RuleMessageLevel, RuleMessageName, RuleMessageProvider, RuleMessageProviderData, RuleMessageSequence, RuleMessageState, RuleMessageUserFlags, RuleName, RuleProvider, RuleProviderData, RuleSequence, RuleState, RuleUserFlags, RwRulesStream, ScheduleInfoAppointmentTombstone, ScheduleInfoAutoAcceptAppointments, ScheduleInfoDelegateEntryIds, ScheduleInfoDelegateNames, ScheduleInfoDelegateNamesW, ScheduleInfoDelegatorWantsCopy, ScheduleInfoDelegatorWantsInfo, ScheduleInfoDisallowOverlappingAppts, ScheduleInfoDisallowRecurringAppts, ScheduleInfoDontMailDelegates, ScheduleInfoFreeBusy, ScheduleInfoFreeBusyAway, ScheduleInfoFreeBusyBusy, ScheduleInfoFreeBusyMerged, ScheduleInfoFreeBusyTentative, ScheduleInfoMonthsAway, ScheduleInfoMonthsBusy, ScheduleInfoMonthsMerged, ScheduleInfoMonthsTentative, ScheduleInfoResourceType, SchedulePlusFreeBusyEntryId, ScriptData, SearchFolderDefinition, SearchFolderEfpFlags, SearchFolderExpiration, SearchFolderId, SearchFolderLastUsed, SearchFolderRecreateInfo, SearchFolderStorageType, SearchFolderTag, SearchFolderTemplateId, SearchKey, SecurityDescriptorAsXml, Selectable, SenderAddressType, SenderEmailAddress, SenderEntryId, SenderIdStatus, SenderName, SenderSearchKey, SenderSmtpAddress, SenderTelephoneNumber, SendInternetEncoding, SendRichInfo, Sensitivity, SentMailSvrEID, SentRepresentingAddressType, SentRepresentingEmailAddress, SentRepresentingEntryId, SentRepresentingFlags, SentRepresentingName, SentRepresentingSearchKey, SentRepresentingSmtpAddress, SmtpAddress, SortLocaleId, SourceKey, SpokenName, SpouseName, StartDate, StartDateEtc, StateOrProvince, StoreEntryId, StoreState, StoreSupportMask, StreetAddress, Subfolders, TagSubject, SubjectPrefix, SupplementaryInfo, Surname, SwappedToDoData, SwappedToDoStore, TargetEntryId, TelecommunicationsDeviceForDeafTelephoneNumber, TelexNumber, TemplateData, Templateid, TextAttachmentCharset, ThumbnailPhoto, TagTitle, TnefCorrelationKey, ToDoItemFlags, TransmittableDisplayName, TransportMessageHeaders, TrustSender, UserCertificate, UserEntryId, UserX509Certificate, ViewDescriptorBinary, ViewDescriptorName, ViewDescriptorStrings, ViewDescriptorVersion, VoiceMessageAttachmentOrder, VoiceMessageDuration, VoiceMessageSenderName, WeddingAnniversary, WlinkAddressBookEID, WlinkAddressBookStoreEID, WlinkCalendarColor, WlinkClientID, WlinkEntryId, WlinkFlags, WlinkFolderType, WlinkGroupClsid, WlinkGroupHeaderID, WlinkGroupName, WlinkOrdinal, WlinkRecordKey, WlinkROGroupType, WlinkSaveStamp, WlinkSection, WlinkStoreEntryId, WlinkType, Abstract, ActiveUserEntryid, AddrbookForLocalSiteEntryid, AddressBookDisplayName, ArrivalTime, AssocMessageSize, AssocMessageSizeExtended, AssocMsgWAttachCount, AttachOnAssocMsgCount, AttachOnNormalMsgCount, AutoAddNewSubs, BilateralInfo, CachedColumnCount, CategCount, ChangeAdvisor, ChangeNotificationGuid, Collector, ContactCount, ContentSearchKey, ContentsSynchronizer, DeletedAssocMessageSizeExtended, DeletedAssocMsgCount, DeletedFolderCount, DeletedMessageSizeExtended, DeletedMsgCount, DeletedNormalMessageSizeExtended, DesignInProgress, DisableFullFidelity, DisableWinsock, DlReportFlags, EformsForLocaleEntryid, EformsLocaleId, EformsRegistryEntryid, EmsAbAccessCategory, EmsAbActivationSchedule, EmsAbActivationStyle, EmsAbAddressEntryDisplayTable, EmsAbAddressEntryDisplayTableMsdos, EmsAbAddressSyntax, EmsAbAddressType, EmsAbAdmd, EmsAbAdminDescription, EmsAbAdminDisplayName, EmsAbAdminExtensionDll, EmsAbAliasedObjectName, EmsAbAliasedObjectNameO, EmsAbAltRecipient, EmsAbAltRecipientBl, EmsAbAltRecipientBlO, EmsAbAltRecipientO, EmsAbAncestorId, EmsAbAnonymousAccess, EmsAbAnonymousAccount, EmsAbAssocNtAccount, EmsAbAssocProtocolCfgNntp, EmsAbAssocProtocolCfgNntpO, EmsAbAssocRemoteDxa, EmsAbAssocRemoteDxaO, EmsAbAssociationLifetime, EmsAbAttributeCertificate, EmsAbAuthOrigBl, EmsAbAuthOrigBlO, EmsAbAuthenticationToUse, EmsAbAuthorityRevocationList, EmsAbAuthorizedDomain, EmsAbAuthorizedPassword, EmsAbAuthorizedPasswordConfirm, EmsAbAuthorizedUser, EmsAbAutoreply, EmsAbAutoreplyMessage, EmsAbAutoreplySubject, EmsAbAvailableAuthorizationPackages, EmsAbAvailableDistributions, EmsAbBridgeheadServers, EmsAbBridgeheadServersO, EmsAbBusinessCategory, EmsAbBusinessRoles, EmsAbCaCertificate, EmsAbCanCreatePf, EmsAbCanCreatePfBl, EmsAbCanCreatePfBlO, EmsAbCanCreatePfDl, EmsAbCanCreatePfDlBl, EmsAbCanCreatePfDlBlO, EmsAbCanCreatePfDlO, EmsAbCanCreatePfO, EmsAbCanNotCreatePf, EmsAbCanNotCreatePfBl, EmsAbCanNotCreatePfBlO, EmsAbCanNotCreatePfDl, EmsAbCanNotCreatePfDlBl, EmsAbCanNotCreatePfDlBlO, EmsAbCanNotCreatePfDlO, EmsAbCanNotCreatePfO, EmsAbCanPreserveDns, EmsAbCertificateChainV3, EmsAbCertificateRevocationList, EmsAbCertificateRevocationListV1, EmsAbCertificateRevocationListV3, EmsAbCharacterSet, EmsAbCharacterSetList, EmsAbChildRdns, EmsAbClientAccessEnabled, EmsAbClockAlertOffset, EmsAbClockAlertRepair, EmsAbClockWarningOffset, EmsAbClockWarningRepair, EmsAbCompromisedKeyList, EmsAbComputerName, EmsAbConnectedDomains, EmsAbConnectionListFilter, EmsAbConnectionListFilterType, EmsAbConnectionType, EmsAbContainerInfo, EmsAbContentType, EmsAbControlMsgFolderId, EmsAbControlMsgRules, EmsAbCost, EmsAbCountryName, EmsAbCrossCertificateCrl, EmsAbCrossCertificatePair, EmsAbDefaultMessageFormat, EmsAbDelegateUser, EmsAbDelivEits, EmsAbDelivExtContTypes, EmsAbDeliverAndRedirect, EmsAbDeliveryMechanism, EmsAbDeltaRevocationList, EmsAbDescription, EmsAbDestinationIndicator, EmsAbDiagnosticRegKey, EmsAbDisableDeferredCommit, EmsAbDisabledGatewayProxy, EmsAbDisplayNameOverride, EmsAbDisplayNameSuffix, EmsAbDlMemRejectPermsBl, EmsAbDlMemRejectPermsBlO, EmsAbDlMemberRule, EmsAbDmdName, EmsAbDoOabVersion, EmsAbDomainDefAltRecip, EmsAbDomainDefAltRecipO, EmsAbDomainName, EmsAbDsaSignature, EmsAbDxaAdminCopy, EmsAbDxaAdminForward, EmsAbDxaAdminUpdate, EmsAbDxaAppendReqcn, EmsAbDxaConfContainerList, EmsAbDxaConfContainerListO, EmsAbDxaConfReqTime, EmsAbDxaConfSeq, EmsAbDxaConfSeqUsn, EmsAbDxaExchangeOptions, EmsAbDxaExportNow, EmsAbDxaFlags, EmsAbDxaImpSeq, EmsAbDxaImpSeqTime, EmsAbDxaImpSeqUsn, EmsAbDxaImportNow, EmsAbDxaInTemplateMap, EmsAbDxaLocalAdmin, EmsAbDxaLocalAdminO, EmsAbDxaLoggingLevel, EmsAbDxaNativeAddressType, EmsAbDxaOutTemplateMap, EmsAbDxaPassword, EmsAbDxaPrevExchangeOptions, EmsAbDxaPrevExportNativeOnly, EmsAbDxaPrevInExchangeSensitivity, EmsAbDxaPrevRemoteEntries, EmsAbDxaPrevRemoteEntriesO, EmsAbDxaPrevReplicationSensitivity, EmsAbDxaPrevTemplateOptions, EmsAbDxaPrevTypes, EmsAbDxaRecipientCp, EmsAbDxaRemoteClient, EmsAbDxaRemoteClientO, EmsAbDxaReqSeq, EmsAbDxaReqSeqTime, EmsAbDxaReqSeqUsn, EmsAbDxaReqname, EmsAbDxaSvrSeq, EmsAbDxaSvrSeqTime, EmsAbDxaSvrSeqUsn, EmsAbDxaTask, EmsAbDxaTemplateOptions, EmsAbDxaTemplateTimestamp, EmsAbDxaTypes, EmsAbDxaUnconfContainerList, EmsAbDxaUnconfContainerListO, EmsAbEmployeeNumber, EmsAbEmployeeType, EmsAbEnableCompatibility, EmsAbEnabled, EmsAbEnabledAuthorizationPackages, EmsAbEnabledProtocolCfg, EmsAbEnabledProtocols, EmsAbEncapsulationMethod, EmsAbEncrypt, EmsAbEncryptAlgListNa, EmsAbEncryptAlgListOther, EmsAbEncryptAlgSelectedNa, EmsAbEncryptAlgSelectedOther, EmsAbExpandDlsLocally, EmsAbExpirationTime, EmsAbExportContainers, EmsAbExportContainersO, EmsAbExportCustomRecipients, EmsAbExtendedCharsAllowed, EmsAbExtensionData, EmsAbExtensionName, EmsAbExtensionNameInherited, EmsAbFacsimileTelephoneNumber, EmsAbFileVersion, EmsAbFilterLocalAddresses, EmsAbFoldersContainer, EmsAbFoldersContainerO, EmsAbFormData, EmsAbForwardingAddress, EmsAbGarbageCollPeriod, EmsAbGatewayLocalCred, EmsAbGatewayLocalDesig, EmsAbGatewayProxy, EmsAbGatewayRoutingTree, EmsAbGenerationQualifier, EmsAbGroupByAttr1, EmsAbGroupByAttr2, EmsAbGroupByAttr3, EmsAbGroupByAttr4, EmsAbGroupByAttrValueDn, EmsAbGroupByAttrValueDnO, EmsAbGroupByAttrValueStr, EmsAbGwartLastModified, EmsAbHasFullReplicaNcs, EmsAbHasFullReplicaNcsO, EmsAbHasMasterNcs, EmsAbHasMasterNcsO, EmsAbHelpData16, EmsAbHelpData32, EmsAbHelpFileName, EmsAbHeuristics, EmsAbHideDlMembership, EmsAbHideFromAddressBook, EmsAbHierarchyPath, EmsAbHomeMdbBl, EmsAbHomeMdbBlO, EmsAbHomeMta, EmsAbHomeMtaO, EmsAbHomePublicServer, EmsAbHomePublicServerO, EmsAbHouseIdentifier, EmsAbHttpPubAbAttributes, EmsAbHttpPubGal, EmsAbHttpPubGalLimit, EmsAbHttpPubPf, EmsAbHttpServers, EmsAbImportContainer, EmsAbImportContainerO, EmsAbImportSensitivity, EmsAbImportedFrom, EmsAbInboundAcceptAll, EmsAbInboundDn, EmsAbInboundDnO, EmsAbInboundHost, EmsAbInboundNewsfeed, EmsAbInboundNewsfeedType, EmsAbInboundSites, EmsAbInboundSitesO, EmsAbIncomingMsgSizeLimit, EmsAbIncomingPassword, EmsAbInsadmin, EmsAbInsadminO, EmsAbInstanceType, EmsAbInternationalIsdnNumber, EmsAbInvocationId, EmsAbIsDeleted, EmsAbIsSingleValued, EmsAbKccStatus, EmsAbKmServer, EmsAbKmServerO, EmsAbKnowledgeInformation, EmsAbLabeleduri, EmsAbLanguage, EmsAbLanguageIso639, EmsAbLdapDisplayName, EmsAbLdapSearchCfg, EmsAbLineWrap, EmsAbLinkId, EmsAbListPublicFolders, EmsAbLocalBridgeHead, EmsAbLocalBridgeHeadAddress, EmsAbLocalInitialTurn, EmsAbLocalScope, EmsAbLocalScopeO, EmsAbLogFilename, EmsAbLogRolloverInterval, EmsAbMailDrop, EmsAbMaintainAutoreplyHistory, EmsAbMapiDisplayType, EmsAbMapiId, EmsAbMaximumObjectId, EmsAbMdbBackoffInterval, EmsAbMdbMsgTimeOutPeriod, EmsAbMdbOverQuotaLimit, EmsAbMdbStorageQuota, EmsAbMdbUnreadLimit, EmsAbMdbUseDefaults, EmsAbMessageTrackingEnabled, EmsAbMimeTypes, EmsAbModerated, EmsAbModerator, EmsAbMonitorClock, EmsAbMonitorServers, EmsAbMonitorServices, EmsAbMonitoredConfigurations, EmsAbMonitoredConfigurationsO, EmsAbMonitoredServers, EmsAbMonitoredServersO, EmsAbMonitoredServices, EmsAbMonitoringAlertDelay, EmsAbMonitoringAlertUnits, EmsAbMonitoringAvailabilityStyle, EmsAbMonitoringAvailabilityWindow, EmsAbMonitoringCachedViaMail, EmsAbMonitoringCachedViaMailO, EmsAbMonitoringCachedViaRpc, EmsAbMonitoringCachedViaRpcO, EmsAbMonitoringEscalationProcedure, EmsAbMonitoringHotsitePollInterval, EmsAbMonitoringHotsitePollUnits, EmsAbMonitoringMailUpdateInterval, EmsAbMonitoringMailUpdateUnits, EmsAbMonitoringNormalPollInterval, EmsAbMonitoringNormalPollUnits, EmsAbMonitoringRecipients, EmsAbMonitoringRecipientsNdr, EmsAbMonitoringRecipientsNdrO, EmsAbMonitoringRecipientsO, EmsAbMonitoringRpcUpdateInterval, EmsAbMonitoringRpcUpdateUnits, EmsAbMonitoringWarningDelay, EmsAbMonitoringWarningUnits, EmsAbMtaLocalCred, EmsAbMtaLocalDesig, EmsAbNAddress, EmsAbNAddressType, EmsAbNewsfeedType, EmsAbNewsgroup, EmsAbNewsgroupList, EmsAbNntpCharacterSet, EmsAbNntpContentFormat, EmsAbNntpDistributions, EmsAbNntpDistributionsFlag, EmsAbNntpNewsfeeds, EmsAbNntpNewsfeedsO, EmsAbNtMachineName, EmsAbNtSecurityDescriptor, EmsAbNumOfOpenRetries, EmsAbNumOfTransferRetries, EmsAbObjViewContainers, EmsAbObjViewContainersO, EmsAbObjectClassCategory, EmsAbObjectOid, EmsAbObjectVersion, EmsAbOffLineAbContainers, EmsAbOffLineAbContainersO, EmsAbOffLineAbSchedule, EmsAbOffLineAbServer, EmsAbOffLineAbServerO, EmsAbOffLineAbStyle, EmsAbOidType, EmsAbOmObjectClass, EmsAbOmSyntax, EmsAbOofReplyToOriginator, EmsAbOpenRetryInterval, EmsAbOrganizationName, EmsAbOrganizationalUnitName, EmsAbOriginalDisplayTable, EmsAbOriginalDisplayTableMsdos, EmsAbOtherRecips, EmsAbOutboundHost, EmsAbOutboundHostType, EmsAbOutboundNewsfeed, EmsAbOutboundSites, EmsAbOutboundSitesO, EmsAbOutgoingMsgSizeLimit, EmsAbOverrideNntpContentFormat, EmsAbOwaServer, EmsAbPSelector, EmsAbPSelectorInbound, EmsAbPerMsgDialogDisplayTable, EmsAbPerRecipDialogDisplayTable, EmsAbPeriodRepSyncTimes, EmsAbPeriodReplStagger, EmsAbPersonalTitle, EmsAbPfContacts, EmsAbPfContactsO, EmsAbPopCharacterSet, EmsAbPopContentFormat, EmsAbPortNumber, EmsAbPostalAddress, EmsAbPreferredDeliveryMethod, EmsAbPreserveInternetContent, EmsAbPrmd, EmsAbPromoExpiration, EmsAbProtocolSettings, EmsAbProxyGenerationEnabled, EmsAbProxyGeneratorDll, EmsAbPublicDelegatesBl, EmsAbPublicDelegatesBlO, EmsAbQuotaNotificationSchedule, EmsAbQuotaNotificationStyle, EmsAbRangeLower, EmsAbRangeUpper, EmsAbRasAccount, EmsAbRasCallbackNumber, EmsAbRasPassword, EmsAbRasPhoneNumber, EmsAbRasPhonebookEntryName, EmsAbRasRemoteSrvrName, EmsAbReferralList, EmsAbRegisteredAddress, EmsAbRemoteBridgeHead, EmsAbRemoteBridgeHeadAddress, EmsAbRemoteOutBhServer, EmsAbRemoteOutBhServerO, EmsAbRemoteSite, EmsAbRemoteSiteO, EmsAbReplicatedObjectVersion, EmsAbReplicationMailMsgSize, EmsAbReplicationSensitivity, EmsAbReplicationStagger, EmsAbReportToOriginator, EmsAbReportToOwner, EmsAbReqSeq, EmsAbRequireSsl, EmsAbResponsibleLocalDxa, EmsAbResponsibleLocalDxaO, EmsAbReturnExactMsgSize, EmsAbRidServer, EmsAbRidServerO, EmsAbRoleOccupant, EmsAbRoleOccupantO, EmsAbRootNewsgroupsFolderId, EmsAbRoutingList, EmsAbRtsCheckpointSize, EmsAbRtsRecoveryTimeout, EmsAbRtsWindowSize, EmsAbRunsOn, EmsAbRunsOnO, EmsAbSSelector, EmsAbSSelectorInbound, EmsAbSchemaFlags, EmsAbSchemaVersion, EmsAbSearchFlags, EmsAbSearchGuide, EmsAbSecurityPolicy, EmsAbSecurityProtocol, EmsAbSeeAlso, EmsAbSeeAlsoO, EmsAbSendEmailMessage, EmsAbSendTnef, EmsAbSerialNumber, EmsAbServer, EmsAbServiceActionFirst, EmsAbServiceActionOther, EmsAbServiceActionSecond, EmsAbServiceRestartDelay, EmsAbServiceRestartMessage, EmsAbSessionDisconnectTimer, EmsAbSiteAffinity, EmsAbSiteFolderGuid, EmsAbSiteFolderServer, EmsAbSiteFolderServerO, EmsAbSiteProxySpace, EmsAbSmimeAlgListNa, EmsAbSmimeAlgListOther, EmsAbSmimeAlgSelectedNa, EmsAbSmimeAlgSelectedOther, EmsAbSpaceLastComputed, EmsAbStreetAddress, EmsAbSubRefs, EmsAbSubRefsO, EmsAbSubSite, EmsAbSubmissionContLength, EmsAbSupportSmimeSignatures, EmsAbSupportedAlgorithms, EmsAbSupportedApplicationContext, EmsAbSupportingStack, EmsAbSupportingStackBl, EmsAbSupportingStackBlO, EmsAbSupportingStackO, EmsAbTSelector, EmsAbTSelectorInbound, EmsAbTargetMtas, EmsAbTelephoneNumber, EmsAbTelephonePersonalPager, EmsAbTeletexTerminalIdentifier, EmsAbTempAssocThreshold, EmsAbTombstoneLifetime, EmsAbTrackingLogPathName, EmsAbTransRetryMins, EmsAbTransTimeoutMins, EmsAbTransferRetryInterval, EmsAbTransferTimeoutNonUrgent, EmsAbTransferTimeoutNormal, EmsAbTransferTimeoutUrgent, EmsAbTranslationTableUsed, EmsAbTransportExpeditedData, EmsAbTrustLevel, EmsAbTurnRequestThreshold, EmsAbTwoWayAlternateFacility, EmsAbType, EmsAbUnauthOrigBl, EmsAbUnauthOrigBlO, EmsAbUseServerValues, EmsAbUseSiteValues, EmsAbUsenetSiteName, EmsAbUserPassword, EmsAbUsnChanged, EmsAbUsnCreated, EmsAbUsnDsaLastObjRemoved, EmsAbUsnIntersite, EmsAbUsnLastObjRem, EmsAbUsnSource, EmsAbViewContainer1, EmsAbViewContainer2, EmsAbViewContainer3, EmsAbViewDefinition, EmsAbViewFlags, EmsAbViewSite, EmsAbVoiceMailFlags, EmsAbVoiceMailGreetings, EmsAbVoiceMailPassword, EmsAbVoiceMailRecordedName, EmsAbVoiceMailRecordingLength, EmsAbVoiceMailSpeed, EmsAbVoiceMailSystemGuid, EmsAbVoiceMailUserId, EmsAbVoiceMailVolume, EmsAbWwwHomePage, EmsAbX121Address, EmsAbX25CallUserDataIncoming, EmsAbX25CallUserDataOutgoing, EmsAbX25FacilitiesDataIncoming, EmsAbX25FacilitiesDataOutgoing, EmsAbX25LeasedLinePort, EmsAbX25LeasedOrSwitched, EmsAbX25RemoteMtaPhone, EmsAbX400AttachmentType, EmsAbX400SelectorSyntax, EmsAbX500AccessControlList, EmsAbX500Nc, EmsAbX500Rdn, EmsAbXmitTimeoutNonUrgent, EmsAbXmitTimeoutNormal, EmsAbXmitTimeoutUrgent, EventsRootFolderEntryid, ExcessStorageUsed, ExtendedAclData, FastTransfer, FavoritesDefaultName, FolderChildCount, FolderDesignFlags, FolderPathname, ForeignId, ForeignReportId, ForeignSubjectId, FreeBusyForLocalSiteEntryid, GwAdminOperations, GwMtsinEntryid, GwMtsoutEntryid, HasModeratorRules, HierarchyServer, HierarchySynchronizer, ImapInternalDate, InTransit, InboundNewsfeedDn, InternetCharset, InternetNewsgroupName, IpmDafEntryid, IpmFavoritesEntryid, IpmPublicFoldersEntryid, IsNewsgroup, IsNewsgroupAnchor, LastAccessTime, LastFullBackup, LastLogoffTime, LastLogonTime, LongtermEntryidFromTable, MessageProcessed, MessageSiteName, MoveToFolderEntryid, MoveToStoreEntryid, MsgBodyId, MtsSubjectId, NewSubsGetAutoAdd, NewsfeedInfo, NewsgroupComponent, NewsgroupRootFolderEntryid, NntpArticleFolderEntryid, NntpControlFolderEntryid, NonIpmSubtreeEntryid, NormalMessageSize, NormalMessageSizeExtended, NormalMsgWAttachCount, NtUserName, OfflineAddrbookEntryid, OfflineFlags, OfflineMessageEntryid, OldestDeletedOn, OriginatorAddr, OriginatorAddrtype, OriginatorEntryid, OriginatorName, OstEncryption, OutboundNewsfeedDn, OverallAgeLimit, OverallMsgAgeLimit, OwaUrl, OwnerCount, P1Content, P1ContentType, PreventMsgCreate, Preview, PreviewUnread, ProfileAbFilesPath, ProfileAddrInfo, ProfileAllpubComment, ProfileAllpubDisplayName, ProfileBindingOrder, ProfileConfigFlags, ProfileConnectFlags, ProfileFavfldComment, ProfileFavfldDisplayName, ProfileHomeServer, ProfileHomeServerAddrs, ProfileHomeServerDn, ProfileMailbox, ProfileMaxRestrict, ProfileMoab, ProfileMoabGuid, ProfileMoabSeq, ProfileOfflineInfo, ProfileOfflineStorePath, ProfileOpenFlags, ProfileOptionsData, ProfileSecureMailbox, ProfileServer, ProfileServerDn, ProfileTransportFlags, ProfileType, ProfileUiState, ProfileUnresolvedName, ProfileUnresolvedServer, ProfileUser, ProfileVersion, PstEncryption, PstPath, PstPwSzOld, PstRememberPw, PublicFolderEntryid, PublishInAddressBook, RecipientNumber, RecipientOnAssocMsgCount, RecipientOnNormalMsgCount, ReplicaList, ReplicaServer, ReplicaVersion, ReplicationAlwaysInterval, ReplicationMessagePriority, ReplicationMsgSize, ReplicationSchedule, ReplicationStyle, ReplyRecipientSmtpProxies, ReportDestinationEntryid, ReportDestinationName, RestrictionCount, RetentionAgeLimit, RuleTriggerHistory, RulesData, RulesTable, ScheduleFolderEntryid, SecureInSite, SecureOrigination, StorageLimitInformation, StorageQuotaLimit, StoreOffline, StoreSlowlink, SubjectTraceInfo, SvrGeneratingQuotaMsg, SynchronizeFlags, SysConfigFolderEntryid, TestLineSpeed, TraceInfo, TransferEnabled, UserName, X400EnvelopeType, AbDefaultDir, AbDefaultPab, AbProviderId, AbProviders, AbSearchPath, AbSearchPathUpdate, AlternateRecipient, AssocContentCount, AttachmentX400Parameters, AuthorizingUsers, BodyCrc, CommonViewsEntryid, ContactAddrtypes, ContactDefaultAddressIndex, ContactEmailAddresses, ContactEntryids, ContactVersion, ContainerModifyVersion, ContentConfidentialityAlgorithmId, ContentCorrelator, ContentIdentifier, ContentIntegrityCheck, ContentLength, ContentReturnRequested, ContentsSortOrder, ControlFlags, ControlId, ControlStructure, ControlType, ConversationKey, ConversionEits, ConversionProhibited, ConversionWithLossProhibited, ConvertedEits, Correlate, CorrelateMtsid, CreateTemplates, CreationVersion, ExCurrentVersion, DefCreateDl, DefCreateMailuser, DefaultProfile, DefaultStore, DefaultViewEntryid, Delegation, DeliveryPoint, Deltax, Deltay, DetailsTable, DiscVal, DiscardReason, DiscloseRecipients, DisclosureOfRecipients, DiscreteValues, DlExpansionHistory, DlExpansionProhibited, ExplicitConversion, FilteringHooks, FinderEntryid, FormCategory, FormCategorySub, FormClsid, FormContactName, FormDesignerGuid, FormDesignerName, FormHidden, FormHostMap, FormMessageBehavior, FormVersion, HeaderFolderEntryid, Icon, IdentityDisplay, IdentityEntryid, IdentitySearchKey, ImplicitConversionProhibited, IncompleteCopy, InternetApproved, InternetArticleNumber, InternetControl, InternetDistribution, InternetFollowupTo, InternetLines, InternetNewsgroups, InternetNntpPath, InternetOrganization, InternetPrecedence, IpmId, IpmOutboxEntryid, IpmOutboxSearchKey, IpmReturnRequested, IpmSentmailEntryid, IpmSentmailSearchKey, IpmSubtreeEntryid, IpmSubtreeSearchKey, IpmWastebasketEntryid, IpmWastebasketSearchKey, Languages, LatestDeliveryTime, MailPermission, MdbProvider, MessageDeliveryId, MessageDownloadTime, MessageSecurityLabel, MessageToken, MiniIcon, ModifyVersion, NewsgroupName, NntpXref, NonReceiptReason, ObsoletedIpms, OriginCheck, OriginalAuthorAddrtype, OriginalAuthorEmailAddress, OriginalAuthorSearchKey, OriginalDisplayName, OriginalEits, OriginalSearchKey, OriginallyIntendedRecipAddrtype, OriginallyIntendedRecipEmailAddress, OriginallyIntendedRecipEntryid, OriginallyIntendedRecipientName, OriginatingMtaCertificate, OriginatorAndDlExpansionHistory, OriginatorCertificate, OriginatorRequestedAlternateRecipient, OriginatorReturnAddress, OwnStoreEntryid, ParentDisplay, PhysicalDeliveryBureauFaxDelivery, PhysicalDeliveryMode, PhysicalDeliveryReportRequest, PhysicalForwardingAddress, PhysicalForwardingAddressRequested, PhysicalForwardingProhibited, PhysicalRenditionAttributes, PostFolderEntries, PostFolderNames, PostReplyDenied, PostReplyFolderEntries, PostReplyFolderNames, Preprocess, PrimaryCapability, ProfileName, ProofOfDelivery, ProofOfDeliveryRequested, ProofOfSubmission, ProofOfSubmissionRequested, ProviderDisplay, ProviderDllName, ProviderOrdinal, ProviderSubmitTime, ProviderUid, ReceiveFolderSettings, RecipientCertificate, RecipientNumberForAdvice, RecipientStatus, RedirectionHistory, RegisteredMailType, RelatedIpms, RemoteProgress, RemoteProgressText, RemoteValidateOk, ReportingDlName, ReportingMtaCertificate, RequestedDeliveryMethod, ResourceFlags, ResourceMethods, ResourcePath, ResourceType, ReturnedIpm, RtfSyncBodyCount, RtfSyncBodyCrc, RtfSyncBodyTag, RtfSyncPrefixCount, RtfSyncTrailingCount, Search, ExSecurity, SentmailEntryid, ServiceDeleteFiles, ServiceDllName, ServiceEntryName, ServiceExtraUids, ServiceName, ServiceSupportFiles, ServiceUid, Services, SpoolerStatus, Status, StatusCode, StatusString, StoreProviders, StoreRecordKey, SubjectIpm, SubmitFlags, Supersedes, TransportKey, TransportProviders, TransportStatus, TypeOfMtsUser, ValidFolderMask, ViewsEntryid, X400ContentType, X400DeferredDeliveryCancel, Xpos, Ypos | - Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) +Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiLegacyFreeBusyPropertyDto.md b/sdk/docs/MapiLegacyFreeBusyPropertyDto.md index 0e716d6..24ed391 100644 --- a/sdk/docs/MapiLegacyFreeBusyPropertyDto.md +++ b/sdk/docs/MapiLegacyFreeBusyPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiLegacyFreeBusyPropertyDto + +Mapi property with LegacyFreeBusyType value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Represents the free/busy status for a calendar event. Enum, available values: Free, Tentative, Busy, Oof, WorkingElsewhere, NoData | +**value** |**str** |Represents the free/busy status for a calendar event. Enum, available values: Free, Tentative, Busy, Oof, WorkingElsewhere, NoData | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiMessageApi.md b/sdk/docs/MapiMessageApi.md index 243e341..2e49b7a 100644 --- a/sdk/docs/MapiMessageApi.md +++ b/sdk/docs/MapiMessageApi.md @@ -1,118 +1,627 @@ -# AsposeEmailCloudSdk.MapiMessageApi +# AsposeEmailCloudSdk.MapiMessageApi (EmailCloud.mapi.message) + +MAPI message operations - -# as_email_dto +## as_email_dto + +Description: Converts MAPI message model to EmailDto model + +Returns: EmailDto model +Method call example: ```python -as_email_dto(self, MapiMessageDto mapi_message) +result = api.mapi.message.as_email_dto(mapi_message) ``` -Converts MAPI message model to EmailDto model +### Parameter: mapi_message + +Description: MAPI message model to convert + +See parameter model documentation at [MapiMessageDto](MapiMessageDto.md) -### Return type +
+ Parameter initialization example: + +```python +mapi_message = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` -[**EmailDto**](EmailDto.md) +
-### mapi_message Parameter +### Result -See parameter model documentation at [MapiMessageDto](MapiMessageDto.md) +Description: EmailDto model + +Return type: [**EmailDto**](EmailDto.md) + +
+ Result example + +```python +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +mapi_message = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') + +// Call method: +result = api.mapi.message.as_email_dto(mapi_message) + +// Result example: +result = models.EmailDto( + attachments=[ + models.Attachment( + name='some-file.txt', + base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')], + body='Some body', + body_type='Html', + delivery_notification_options=[ + 'OnSuccess', + 'Delay'], + _from=models.MailAddress( + display_name='From Address', + address='from@aspose.com'), + html_body='Some body', + is_body_html=True, + is_draft=True, + subject='Re: Some subject', + to=[ + models.MailAddress( + display_name='To Address', + address='to@aspose.com')]) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# as_file +## as_file +Description: Converts MAPI message model to specified format and returns as file. + +Returns: File stream in specified format. + +Method call example: +```python +result = api.mapi.message.as_file(request) +``` + +### Parameter: request + +Description: MAPI message model to convert. + +See parameter model documentation at [MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) + +
+ Parameter initialization example: + ```python -as_file(self, MapiMessageAsFileRequest request) +request = models.MapiMessageAsFileRequest( + format='Msg', + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) ``` -Converts MAPI message model to specified format and returns as file. +
-### Return type +### Result -**Stream** +Description: File stream in specified format. -### request Parameter +Return type: **Stream** -See parameter model documentation at [MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiMessageAsFileRequest( + format='Msg', + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) + +// Call method: +result = api.mapi.message.as_file(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# from_file +## from_file + +Description: Converts email file to a MAPI model representation + +Returns: MAPI model + +Method call example: +```python +result = api.mapi.message.from_file(request) +``` + +### Parameter: request + +Description: from_file method request. +See parameter model documentation at [MapiMessageFromFileRequest](MapiMessageFromFileRequest.md). + +
+ Parameter initialization example: + ```python -from_file(self, request: MapiMessageFromFileRequest) +request = models.MapiMessageFromFileRequest( + format='Msg', + file='/path/to/message.msg') ``` -Converts email file to a MAPI model representation +
+ +### Result + +Description: MAPI model + +Return type: [**MapiMessageDto**](MapiMessageDto.md) + +
+ Result example + +```python +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` +
-### Return type +### Complete example -MapiMessageDto +
+ Method call example: -### request Parameter ```python -MapiMessageFromFileRequest( - format, - file) +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiMessageFromFileRequest( + format='Msg', + file='/path/to/message.msg') + +// Call method: +result = api.mapi.message.from_file(request) + +// Result example: +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **file** | **str** | File to convert | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get +## get + +Description: Get MAPI message document. + +Returns: MAPI message document. +Method call example: ```python -get(self, request: MapiMessageGetRequest) +result = api.mapi.message.get(request) ``` -Get MAPI message document. +### Parameter: request -### Return type +Description: get method request. -MapiMessageDto +See parameter model documentation at [MapiMessageGetRequest](MapiMessageGetRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -MapiMessageGetRequest( - format, - file_name, - folder, - storage) +request = models.MapiMessageGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - **file_name** | **str** | Email document file name. | - **folder** | **str** | Path to folder in storage. | [optional] - **storage** | **str** | Storage name. | [optional] +
+ +### Result + +Description: MAPI message document. + +Return type: [**MapiMessageDto**](MapiMessageDto.md) + +
+ Result example + +```python +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiMessageGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') + +// Call method: +result = api.mapi.message.get(request) + +// Result example: +result = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# save +## save + +Description: Save MAPI message to storage. +Method call example: ```python -save(self, MapiMessageSaveRequest request) +api.mapi.message.save(request) ``` -Save MAPI message to storage. +### Parameter: request -### Return type +Description: Message create/update request. -void (empty response body) +See parameter model documentation at [MapiMessageSaveRequest](MapiMessageSaveRequest.md) -### request Parameter +
+ Parameter initialization example: + +```python +request = models.MapiMessageSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='message.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) +``` -See parameter model documentation at [MapiMessageSaveRequest](MapiMessageSaveRequest.md) +
+ +### Result + +Return type: void (empty response body) + +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.MapiMessageSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='message.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) + +// Call method: +api.mapi.message.save(request) +``` + +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiMessageApi_list.md b/sdk/docs/MapiMessageApi_list.md index 9df24f4..0dcf87e 100644 --- a/sdk/docs/MapiMessageApi_list.md +++ b/sdk/docs/MapiMessageApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for MapiMessageApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/MapiMessageAsFileRequest.md b/sdk/docs/MapiMessageAsFileRequest.md index 1df6425..55268a5 100644 --- a/sdk/docs/MapiMessageAsFileRequest.md +++ b/sdk/docs/MapiMessageAsFileRequest.md @@ -1,12 +1,49 @@ # AsposeEmailCloudSdk.models.MapiMessageAsFileRequest + +Convert MapiMessage to file request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | -**value** | [**MapiMessageDto**](MapiMessageDto.md) | MAPI message model. | +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**value** |[**MapiMessageDto**](MapiMessageDto.md) |MAPI message model. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_message_as_file_request = models.MapiMessageAsFileRequest( + format='Msg', + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiMessageDto.md b/sdk/docs/MapiMessageDto.md index 272a49d..0f56ecd 100644 --- a/sdk/docs/MapiMessageDto.md +++ b/sdk/docs/MapiMessageDto.md @@ -1,35 +1,71 @@ # AsposeEmailCloudSdk.models.MapiMessageDto + +Represents an Outlook Message format document. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message_body** | **str** | Message text | [optional] -**client_submit_time** | **datetime** | Date and time the message sender submitted a message. | -**conversation_topic** | **str** | Topic of the first message in a conversation thread. | [optional] -**delivery_time** | **datetime** | Date and time a message was delivered. | -**display_bcc** | **str** | List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). | [optional] -**display_cc** | **str** | List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). | [optional] -**display_name** | **str** | Display name for the message. | [optional] -**display_name_prefix** | **str** | Prefix of the display name. | [optional] -**display_to** | **str** | List of the display names of the primary (To) message recipients, separated by semicolons (;). | [optional] -**flags** | **list[str]** | Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt | [optional] -**headers** | **dict(str, str)** | Transport message headers | [optional] -**internet_message_id** | **str** | Internet message id of the message. | [optional] -**message_format** | **str** | Represents outlook message format. Enum, available values: Ascii, Unicode | -**normalized_subject** | **str** | Normalized subject of the message. | [optional] -**read_receipt_requested** | **bool** | Value indicating whether the read receipt is requested. | -**reply_to** | **str** | Reply to names. | [optional] -**sender_address_type** | **str** | Message sender's e-mail address type. | [optional] -**sender_email_address** | **str** | Message sender's e-mail address. | [optional] -**sender_name** | **str** | Message sender's display name. | [optional] -**sender_smtp_address** | **str** | Message sender's e-mail address. | [optional] -**sent_representing_address_type** | **str** | Address type for the messaging user represented by the sender. | [optional] -**sent_representing_email_address** | **str** | E-mail address for the messaging user represented by the sender. | [optional] -**sent_representing_name** | **str** | Display name for the messaging user represented by the sender. | [optional] -**sent_representing_smtp_address** | **str** | E-mail address for the messaging user represented by the sender. | [optional] -**transport_message_headers** | **str** | Transport-specific message envelope information. | [optional] - - Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) +**message_body** |**str** |Message text |[optional] +**client_submit_time** |**datetime** |Date and time the message sender submitted a message. | +**conversation_topic** |**str** |Topic of the first message in a conversation thread. |[optional] +**delivery_time** |**datetime** |Date and time a message was delivered. | +**display_bcc** |**str** |List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). |[optional] +**display_cc** |**str** |List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). |[optional] +**display_name** |**str** |Display name for the message. |[optional] +**display_name_prefix** |**str** |Prefix of the display name. |[optional] +**display_to** |**str** |List of the display names of the primary (To) message recipients, separated by semicolons (;). |[optional] +**flags** |**list[str]** |Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt |[optional] +**headers** |**dict(str, str)** |Transport message headers |[optional] +**internet_message_id** |**str** |Internet message id of the message. |[optional] +**message_format** |**str** |Represents outlook message format. Enum, available values: Ascii, Unicode | +**normalized_subject** |**str** |Normalized subject of the message. |[optional] +**read_receipt_requested** |**bool** |Value indicating whether the read receipt is requested. | +**reply_to** |**str** |Reply to names. |[optional] +**sender_address_type** |**str** |Message sender's e-mail address type. |[optional] +**sender_email_address** |**str** |Message sender's e-mail address. |[optional] +**sender_name** |**str** |Message sender's display name. |[optional] +**sender_smtp_address** |**str** |Message sender's e-mail address. |[optional] +**sent_representing_address_type** |**str** |Address type for the messaging user represented by the sender. |[optional] +**sent_representing_email_address** |**str** |E-mail address for the messaging user represented by the sender. |[optional] +**sent_representing_name** |**str** |Display name for the messaging user represented by the sender. |[optional] +**sent_representing_smtp_address** |**str** |E-mail address for the messaging user represented by the sender. |[optional] +**transport_message_headers** |**str** |Transport-specific message envelope information. |[optional] + +Parent class: [MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_message_dto = models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiMessageFromFileRequest.md b/sdk/docs/MapiMessageFromFileRequest.md new file mode 100644 index 0000000..357c980 --- /dev/null +++ b/sdk/docs/MapiMessageFromFileRequest.md @@ -0,0 +1,17 @@ +# MapiMessageFromFileRequest + +Request model for MapiMessageApi.from_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**file** |**str** |File to convert | + +## Example +```python +request = models.MapiMessageFromFileRequest( + format='Msg', + file='/path/to/message.msg') +``` diff --git a/sdk/docs/MapiMessageGetRequest.md b/sdk/docs/MapiMessageGetRequest.md new file mode 100644 index 0000000..15f7fef --- /dev/null +++ b/sdk/docs/MapiMessageGetRequest.md @@ -0,0 +1,21 @@ +# MapiMessageGetRequest + +Request model for MapiMessageApi.get + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**file_name** |**str** |Email document file name. | +**folder** |**str** |Path to folder in storage. |[optional] +**storage** |**str** |Storage name. |[optional] + +## Example +```python +request = models.MapiMessageGetRequest( + format='Eml', + file_name='email.eml', + folder='folder/on/storage', + storage='First Storage') +``` diff --git a/sdk/docs/MapiMessageItemBaseDto.md b/sdk/docs/MapiMessageItemBaseDto.md index 1f49066..cc71a6b 100644 --- a/sdk/docs/MapiMessageItemBaseDto.md +++ b/sdk/docs/MapiMessageItemBaseDto.md @@ -1,27 +1,30 @@ # AsposeEmailCloudSdk.models.MapiMessageItemBaseDto + +Base Dto for MapiMessage, MapiCalendar or MapiContact + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attachments** | [**list[MapiAttachmentDto]**](MapiAttachmentDto.md) | Message item attachments. | [optional] -**billing** | **str** | Billing information associated with an item. | [optional] -**body** | **str** | Message text. | [optional] -**body_html** | **str** | Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. | [optional] -**body_rtf** | **str** | RTF formatted message text. | [optional] -**body_type** | **str** | The content type of message body. Enum, available values: PlainText, Html, Rtf | -**categories** | **list[str]** | Contains keywords or categories for the message object. | [optional] -**companies** | **list[str]** | Contains the names of the companies that are associated with an item. | [optional] -**item_id** | **str** | The item id, uses with a server. | [optional] -**message_class** | **str** | Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. | [optional] -**mileage** | **str** | Contains the mileage information that is associated with an item. | [optional] -**recipients** | [**list[MapiRecipientDto]**](MapiRecipientDto.md) | Recipients of the message. | [optional] -**sensitivity** | **str** | Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential | -**subject** | **str** | Subject of the message. | [optional] -**subject_prefix** | **str** | Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding. | [optional] -**properties** | [**list[MapiPropertyDto]**](MapiPropertyDto.md) | List of MAPI properties | [optional] -**discriminator** | **str** | | +**attachments** |[**list[MapiAttachmentDto]**](MapiAttachmentDto.md) |Message item attachments. |[optional] +**billing** |**str** |Billing information associated with an item. |[optional] +**body** |**str** |Message text. |[optional] +**body_html** |**str** |Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. |[optional] +**body_rtf** |**str** |RTF formatted message text. |[optional] +**body_type** |**str** |The content type of message body. Enum, available values: PlainText, Html, Rtf | +**categories** |**list[str]** |Contains keywords or categories for the message object. |[optional] +**companies** |**list[str]** |Contains the names of the companies that are associated with an item. |[optional] +**item_id** |**str** |The item id, uses with a server. |[optional] +**message_class** |**str** |Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. |[optional] +**mileage** |**str** |Contains the mileage information that is associated with an item. |[optional] +**recipients** |[**list[MapiRecipientDto]**](MapiRecipientDto.md) |Recipients of the message. |[optional] +**sensitivity** |**str** |Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential | +**subject** |**str** |Subject of the message. |[optional] +**subject_prefix** |**str** |Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding. |[optional] +**properties** |[**list[MapiPropertyDto]**](MapiPropertyDto.md) |List of MAPI properties |[optional] +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiMessageSaveRequest.md b/sdk/docs/MapiMessageSaveRequest.md index f81ec4d..7859f5e 100644 --- a/sdk/docs/MapiMessageSaveRequest.md +++ b/sdk/docs/MapiMessageSaveRequest.md @@ -1,11 +1,53 @@ # AsposeEmailCloudSdk.models.MapiMessageSaveRequest + +MapiMessage save to storage request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | +**format** |**str** |Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft | - Parent class: [StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) +Parent class: [StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_message_save_request = models.MapiMessageSaveRequest( + format='Msg', + storage_file=models.StorageFileLocation( + file_name='message.msg', + storage='First Storage', + folder_path='file/location/folder/on/storage'), + value=models.MapiMessageDto( + message_body='Some body', + client_submit_time=datetime.today(), + delivery_time=datetime.today(), + display_to='To Address', + flags=[ + 'MsgFlagRead', + 'MsgFlagUnsent', + 'MsgFlagHasAttach'], + normalized_subject='Some subject', + sender_address_type='SMTP', + sender_email_address='from@aspose.com', + sender_name='From Address', + sender_smtp_address='from@aspose.com', + attachments=[ + models.MapiAttachmentDto( + name='some-file.txt', + data_base64='U29tZSBmaWxlIHRleHQ=')], + body='Some body', + message_class='IPM.Note', + recipients=[ + models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo')], + subject='Re: Some subject', + subject_prefix='Re: ')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiMultiIntPropertyDto.md b/sdk/docs/MapiMultiIntPropertyDto.md index 24fd3c3..0f9cad4 100644 --- a/sdk/docs/MapiMultiIntPropertyDto.md +++ b/sdk/docs/MapiMultiIntPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiMultiIntPropertyDto + +Mapi property with Multiple Integer values + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**values** | **list[int]** | Property values | [optional] +**values** |**list[int]** |Property values |[optional] - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiMultiStringPropertyDto.md b/sdk/docs/MapiMultiStringPropertyDto.md index fd0bea0..5c279ff 100644 --- a/sdk/docs/MapiMultiStringPropertyDto.md +++ b/sdk/docs/MapiMultiStringPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiMultiStringPropertyDto + +Mapi property with Multiple String values + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**values** | **list[str]** | Property values | [optional] +**values** |**list[str]** |Property values |[optional] - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md b/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md index 9d83145..6730e57 100644 --- a/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md +++ b/sdk/docs/MapiPhysicalAddressIndexPropertyDto.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiPhysicalAddressIndexPropertyDto + +Mapi property with PhysicalAddressIndexType value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Identifies the display types for physical addresses. Enum, available values: None, Home, Business, Other | +**value** |**str** |Identifies the display types for physical addresses. Enum, available values: None, Home, Business, Other | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPidLidPropertyDescriptor.md b/sdk/docs/MapiPidLidPropertyDescriptor.md index 5cdba65..0e322ce 100644 --- a/sdk/docs/MapiPidLidPropertyDescriptor.md +++ b/sdk/docs/MapiPidLidPropertyDescriptor.md @@ -1,12 +1,16 @@ # AsposeEmailCloudSdk.models.MapiPidLidPropertyDescriptor + +Property identified by an unsigned 32-bit quantity along with a property set + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**long_id** | **int** | An unsigned 32-bit quantity that, along with the property set, identifies a named property. | -**property_set** | **str** | A GUID that identifies a group of properties with a similar purpose. | +**long_id** |**int** |An unsigned 32-bit quantity that, along with the property set, identifies a named property. | +**property_set** |**str** |A GUID that identifies a group of properties with a similar purpose. | - Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) +Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPidNamePropertyDescriptor.md b/sdk/docs/MapiPidNamePropertyDescriptor.md index a78c33f..0a8be7f 100644 --- a/sdk/docs/MapiPidNamePropertyDescriptor.md +++ b/sdk/docs/MapiPidNamePropertyDescriptor.md @@ -1,11 +1,15 @@ # AsposeEmailCloudSdk.models.MapiPidNamePropertyDescriptor + +Property identified by a string name along with a property set + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**property_set** | **str** | A GUID that identifies a group of properties with a similar purpose. | +**property_set** |**str** |A GUID that identifies a group of properties with a similar purpose. | - Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) +Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPidPropertyDescriptor.md b/sdk/docs/MapiPidPropertyDescriptor.md index c794a2f..f309cc7 100644 --- a/sdk/docs/MapiPidPropertyDescriptor.md +++ b/sdk/docs/MapiPidPropertyDescriptor.md @@ -1,14 +1,18 @@ # AsposeEmailCloudSdk.models.MapiPidPropertyDescriptor + +Mapi pid property descriptor base class + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canonical_name** | **str** | The name used to refer to the property in the documentation. The prefix of the canonical name identifies the basic characteristics of a property to the implementer. The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name: * PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set. * PidName prefix: Properties identified by a string name along with a property set. * PidTag prefix: Properties identified by an unsigned 16-bit quantity. | [optional] -**data_type** | **str** | [MS-OXCDATA]: Data Structures Enum, available values: Unspecified, Null, Integer16, Integer32, Floating32, Floating64, Currency, FloatingTime, ErrorCode, Boolean, Integer64, String, String8, Time, Guid, ServerId, Restriction, RuleAction, Binary, MultipleInteger16, MultipleInteger32, MultipleFloating32, MultipleFloating64, MultipleCurrency, MultipleFloatingTime, MultipleBoolean, MultipleInteger64, MultipleString, MultipleString8, MultipleTime, MultipleGuid, MultipleBinary, Object | -**multiple_values_data_type** | **bool** | Indicates if data type contains of multiple values | -**name** | **str** | A string that identifies the property | [optional] +**canonical_name** |**str** |The name used to refer to the property in the documentation. The prefix of the canonical name identifies the basic characteristics of a property to the implementer. The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name: * PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set. * PidName prefix: Properties identified by a string name along with a property set. * PidTag prefix: Properties identified by an unsigned 16-bit quantity. |[optional] +**data_type** |**str** |[MS-OXCDATA]: Data Structures Enum, available values: Unspecified, Null, Integer16, Integer32, Floating32, Floating64, Currency, FloatingTime, ErrorCode, Boolean, Integer64, String, String8, Time, Guid, ServerId, Restriction, RuleAction, Binary, MultipleInteger16, MultipleInteger32, MultipleFloating32, MultipleFloating64, MultipleCurrency, MultipleFloatingTime, MultipleBoolean, MultipleInteger64, MultipleString, MultipleString8, MultipleTime, MultipleGuid, MultipleBinary, Object | +**multiple_values_data_type** |**bool** |Indicates if data type contains of multiple values | +**name** |**str** |A string that identifies the property |[optional] - Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) +Parent class: [MapiPropertyDescriptor](MapiPropertyDescriptor.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPidTagPropertyDescriptor.md b/sdk/docs/MapiPidTagPropertyDescriptor.md index f94b00b..ea3a671 100644 --- a/sdk/docs/MapiPidTagPropertyDescriptor.md +++ b/sdk/docs/MapiPidTagPropertyDescriptor.md @@ -1,12 +1,16 @@ # AsposeEmailCloudSdk.models.MapiPidTagPropertyDescriptor + +A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 - 0x7FFF. Property IDs in the range 0x8000 - 0x8FFF are reserved for assignment to named properties + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | An unsigned 16-bit quantity that identifies a tagged property. Property IDs are not necessarily unique. With the exception of property IDs in the range from 0x6800 to 0x7BFF, the combination of property ID and data type are unique. Property IDs in the range from 0x6800 to 0x7BFF are defined by the message class. | -**tag** | **int** | A property tag is a 32-bit number that contains a unique property identifier in bits 16 through 31 and a property type in bits 0 through 15. | +**id** |**int** |An unsigned 16-bit quantity that identifies a tagged property. Property IDs are not necessarily unique. With the exception of property IDs in the range from 0x6800 to 0x7BFF, the combination of property ID and data type are unique. Property IDs in the range from 0x6800 to 0x7BFF are defined by the message class. | +**tag** |**int** |A property tag is a 32-bit number that contains a unique property identifier in bits 16 through 31 and a property type in bits 0 through 15. | - Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) +Parent class: [MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPropertyDescriptor.md b/sdk/docs/MapiPropertyDescriptor.md index 97e09cc..38f5062 100644 --- a/sdk/docs/MapiPropertyDescriptor.md +++ b/sdk/docs/MapiPropertyDescriptor.md @@ -1,11 +1,20 @@ # AsposeEmailCloudSdk.models.MapiPropertyDescriptor + +Mapi property descriptor + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**discriminator** | **str** | | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_property_descriptor = models.MapiPropertyDescriptor( + ) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiPropertyDto.md b/sdk/docs/MapiPropertyDto.md index 90fc72f..c8df300 100644 --- a/sdk/docs/MapiPropertyDto.md +++ b/sdk/docs/MapiPropertyDto.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.MapiPropertyDto + +Mapi property + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**descriptor** | [**MapiPropertyDescriptor**](MapiPropertyDescriptor.md) | Property descriptor | [optional] -**discriminator** | **str** | | +**descriptor** |[**MapiPropertyDescriptor**](MapiPropertyDescriptor.md) |Property descriptor |[optional] +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_property_dto = models.MapiPropertyDto( + descriptor=models.MapiKnownPropertyDescriptor( + name='DisplayName')) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiRecipientDto.md b/sdk/docs/MapiRecipientDto.md index 9021f46..ee2c454 100644 --- a/sdk/docs/MapiRecipientDto.md +++ b/sdk/docs/MapiRecipientDto.md @@ -1,14 +1,26 @@ # AsposeEmailCloudSdk.models.MapiRecipientDto + +Represents the recipient information in the Microsoft Outlook Message. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email_address** | **str** | Email address of the message recipient or sender. | [optional] -**address_type** | **str** | Type of the address of the message recipient or sender. | [optional] -**display_name** | **str** | Display name of the message recipient or sender. | [optional] -**recipient_type** | **str** | Represent the PR_RECIPIENT_TYPE property which contains the recipient type for a message recipient. Enum, available values: Unknown, MapiBcc, MapiCc, MapiP1, MapiSubmitted, MapiTo | +**email_address** |**str** |Email address of the message recipient or sender. |[optional] +**address_type** |**str** |Type of the address of the message recipient or sender. |[optional] +**display_name** |**str** |Display name of the message recipient or sender. |[optional] +**recipient_type** |**str** |Represent the PR_RECIPIENT_TYPE property which contains the recipient type for a message recipient. Enum, available values: Unknown, MapiBcc, MapiCc, MapiP1, MapiSubmitted, MapiTo | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_recipient_dto = models.MapiRecipientDto( + email_address='to@aspose.com', + address_type='SMTP', + display_name='To Address', + recipient_type='MapiTo') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/MapiResponseTypePropertyDto.md b/sdk/docs/MapiResponseTypePropertyDto.md index 723a50e..e89bb43 100644 --- a/sdk/docs/MapiResponseTypePropertyDto.md +++ b/sdk/docs/MapiResponseTypePropertyDto.md @@ -1,11 +1,23 @@ # AsposeEmailCloudSdk.models.MapiResponseTypePropertyDto + +Mapi property with response type value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Represents the types of recipient responses that are received for a meeting. Enum, available values: Unknown, Organizer, Tentative, Accept, Decline, NoResponseReceived | +**value** |**str** |Represents the types of recipient responses that are received for a meeting. Enum, available values: Unknown, Organizer, Tentative, Accept, Decline, NoResponseReceived | - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_response_type_property_dto = models.MapiResponseTypePropertyDto( + value='Accept', + descriptor=models.MapiKnownPropertyDescriptor( + name='ResponseStatus')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MapiStringPropertyDto.md b/sdk/docs/MapiStringPropertyDto.md index 68fc718..dbd5e10 100644 --- a/sdk/docs/MapiStringPropertyDto.md +++ b/sdk/docs/MapiStringPropertyDto.md @@ -1,11 +1,23 @@ # AsposeEmailCloudSdk.models.MapiStringPropertyDto + +Mapi property with string value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | Property value | [optional] +**value** |**str** |Property value |[optional] - Parent class: [MapiPropertyDto](MapiPropertyDto.md) +Parent class: [MapiPropertyDto](MapiPropertyDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +mapi_string_property_dto = models.MapiStringPropertyDto( + value='SomeName', + descriptor=models.MapiKnownPropertyDescriptor( + name='DisplayName')) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/Models.md b/sdk/docs/Models.md index 2b3bf48..bbfcf5f 100644 --- a/sdk/docs/Models.md +++ b/sdk/docs/Models.md @@ -1,192 +1,248 @@ ## Documentation for Models - - [AsposeEmailCloudSdk.models.AiBcrImage](AiBcrImage.md) - - [AsposeEmailCloudSdk.models.AiBcrOptions](AiBcrOptions.md) - - [AsposeEmailCloudSdk.models.AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) - - [AsposeEmailCloudSdk.models.AiNameComponent](AiNameComponent.md) - - [AsposeEmailCloudSdk.models.AiNameCulturalContext](AiNameCulturalContext.md) - - [AsposeEmailCloudSdk.models.AiNameExtracted](AiNameExtracted.md) - - [AsposeEmailCloudSdk.models.AiNameExtractedComponent](AiNameExtractedComponent.md) - - [AsposeEmailCloudSdk.models.AiNameFormatted](AiNameFormatted.md) - - [AsposeEmailCloudSdk.models.AiNameGenderHypothesis](AiNameGenderHypothesis.md) - - [AsposeEmailCloudSdk.models.AiNameMatchResult](AiNameMatchResult.md) - - [AsposeEmailCloudSdk.models.AiNameMismatch](AiNameMismatch.md) - - [AsposeEmailCloudSdk.models.AiNameParsedRequest](AiNameParsedRequest.md) - - [AsposeEmailCloudSdk.models.AiNameWeighted](AiNameWeighted.md) - - [AsposeEmailCloudSdk.models.AiNameWeightedVariants](AiNameWeightedVariants.md) - - [AsposeEmailCloudSdk.models.AssociatedPerson](AssociatedPerson.md) - - [AsposeEmailCloudSdk.models.AttachmentBase](AttachmentBase.md) - - [AsposeEmailCloudSdk.models.CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) - - [AsposeEmailCloudSdk.models.CalendarAsFileRequest](CalendarAsFileRequest.md) - - [AsposeEmailCloudSdk.models.CalendarDto](CalendarDto.md) - - [AsposeEmailCloudSdk.models.CalendarReminder](CalendarReminder.md) - - [AsposeEmailCloudSdk.models.ClientAccountBaseRequest](ClientAccountBaseRequest.md) - - [AsposeEmailCloudSdk.models.ContactAsFileRequest](ContactAsFileRequest.md) - - [AsposeEmailCloudSdk.models.ContactDto](ContactDto.md) - - [AsposeEmailCloudSdk.models.ContactPhoto](ContactPhoto.md) - - [AsposeEmailCloudSdk.models.ContentType](ContentType.md) - - [AsposeEmailCloudSdk.models.ContentTypeParameter](ContentTypeParameter.md) - - [AsposeEmailCloudSdk.models.CustomerEvent](CustomerEvent.md) - - [AsposeEmailCloudSdk.models.DiscUsage](DiscUsage.md) - - [AsposeEmailCloudSdk.models.DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) - - [AsposeEmailCloudSdk.models.EmailAccountConfig](EmailAccountConfig.md) - - [AsposeEmailCloudSdk.models.EmailAddress](EmailAddress.md) - - [AsposeEmailCloudSdk.models.EmailAsFileRequest](EmailAsFileRequest.md) - - [AsposeEmailCloudSdk.models.EmailClientAccount](EmailClientAccount.md) - - [AsposeEmailCloudSdk.models.EmailClientAccountCredentials](EmailClientAccountCredentials.md) - - [AsposeEmailCloudSdk.models.EmailClientMultiAccount](EmailClientMultiAccount.md) - - [AsposeEmailCloudSdk.models.EmailDto](EmailDto.md) - - [AsposeEmailCloudSdk.models.EmailThread](EmailThread.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfAssociatedPersonCategory](EnumWithCustomOfAssociatedPersonCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfEmailAddressCategory](EnumWithCustomOfEmailAddressCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfEventCategory](EnumWithCustomOfEventCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfInstantMessengerCategory](EnumWithCustomOfInstantMessengerCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfPhoneNumberCategory](EnumWithCustomOfPhoneNumberCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfPostalAddressCategory](EnumWithCustomOfPostalAddressCategory.md) - - [AsposeEmailCloudSdk.models.EnumWithCustomOfUrlCategory](EnumWithCustomOfUrlCategory.md) - - [AsposeEmailCloudSdk.models.Error](Error.md) - - [AsposeEmailCloudSdk.models.ErrorDetails](ErrorDetails.md) - - [AsposeEmailCloudSdk.models.FileVersions](FileVersions.md) - - [AsposeEmailCloudSdk.models.FilesList](FilesList.md) - - [AsposeEmailCloudSdk.models.FilesUploadResult](FilesUploadResult.md) - - [AsposeEmailCloudSdk.models.InstantMessengerAddress](InstantMessengerAddress.md) - - [AsposeEmailCloudSdk.models.ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) - - [AsposeEmailCloudSdk.models.ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) - - [AsposeEmailCloudSdk.models.ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) - - [AsposeEmailCloudSdk.models.ListResponseOfContactDto](ListResponseOfContactDto.md) - - [AsposeEmailCloudSdk.models.ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) - - [AsposeEmailCloudSdk.models.ListResponseOfEmailDto](ListResponseOfEmailDto.md) - - [AsposeEmailCloudSdk.models.ListResponseOfEmailThread](ListResponseOfEmailThread.md) - - [AsposeEmailCloudSdk.models.ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) - - [AsposeEmailCloudSdk.models.ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) - - [AsposeEmailCloudSdk.models.ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) - - [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) - - [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) - - [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) - - [AsposeEmailCloudSdk.models.MailAddress](MailAddress.md) - - [AsposeEmailCloudSdk.models.MailMessageBase](MailMessageBase.md) - - [AsposeEmailCloudSdk.models.MailServerFolder](MailServerFolder.md) - - [AsposeEmailCloudSdk.models.MapiAttachmentDto](MapiAttachmentDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) - - [AsposeEmailCloudSdk.models.MapiCalendarAttendeesDto](MapiCalendarAttendeesDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarEventRecurrenceDto](MapiCalendarEventRecurrenceDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarExceptionInfoDto](MapiCalendarExceptionInfoDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneDto](MapiCalendarTimeZoneDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneInfoDto](MapiCalendarTimeZoneInfoDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneRuleDto](MapiCalendarTimeZoneRuleDto.md) - - [AsposeEmailCloudSdk.models.MapiContactAsFileRequest](MapiContactAsFileRequest.md) - - [AsposeEmailCloudSdk.models.MapiContactElectronicAddressDto](MapiContactElectronicAddressDto.md) - - [AsposeEmailCloudSdk.models.MapiContactElectronicAddressPropertySetDto](MapiContactElectronicAddressPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactEventPropertySetDto](MapiContactEventPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactNamePropertySetDto](MapiContactNamePropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactOtherPropertySetDto](MapiContactOtherPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactPersonalInfoPropertySetDto](MapiContactPersonalInfoPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressDto](MapiContactPhysicalAddressDto.md) - - [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressPropertySetDto](MapiContactPhysicalAddressPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactProfessionalPropertySetDto](MapiContactProfessionalPropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiContactTelephonePropertySetDto](MapiContactTelephonePropertySetDto.md) - - [AsposeEmailCloudSdk.models.MapiElectronicAddressDto](MapiElectronicAddressDto.md) - - [AsposeEmailCloudSdk.models.MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) - - [AsposeEmailCloudSdk.models.MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) - - [AsposeEmailCloudSdk.models.MapiPropertyDescriptor](MapiPropertyDescriptor.md) - - [AsposeEmailCloudSdk.models.MapiPropertyDto](MapiPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiRecipientDto](MapiRecipientDto.md) - - [AsposeEmailCloudSdk.models.NameValuePair](NameValuePair.md) - - [AsposeEmailCloudSdk.models.ObjectExist](ObjectExist.md) - - [AsposeEmailCloudSdk.models.PhoneNumber](PhoneNumber.md) - - [AsposeEmailCloudSdk.models.PostalAddress](PostalAddress.md) - - [AsposeEmailCloudSdk.models.RecurrencePatternDto](RecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.ReminderAttendee](ReminderAttendee.md) - - [AsposeEmailCloudSdk.models.ReminderTrigger](ReminderTrigger.md) - - [AsposeEmailCloudSdk.models.StorageExist](StorageExist.md) - - [AsposeEmailCloudSdk.models.StorageFile](StorageFile.md) - - [AsposeEmailCloudSdk.models.StorageFolderLocation](StorageFolderLocation.md) - - [AsposeEmailCloudSdk.models.StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) - - [AsposeEmailCloudSdk.models.StorageModelOfContactDto](StorageModelOfContactDto.md) - - [AsposeEmailCloudSdk.models.StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) - - [AsposeEmailCloudSdk.models.StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) - - [AsposeEmailCloudSdk.models.StorageModelOfEmailDto](StorageModelOfEmailDto.md) - - [AsposeEmailCloudSdk.models.StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) - - [AsposeEmailCloudSdk.models.StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) - - [AsposeEmailCloudSdk.models.StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) - - [AsposeEmailCloudSdk.models.Url](Url.md) - - [AsposeEmailCloudSdk.models.ValueTOfBoolean](ValueTOfBoolean.md) - - [AsposeEmailCloudSdk.models.ValueTOfString](ValueTOfString.md) - - [AsposeEmailCloudSdk.models.AiBcrImageStorageFile](AiBcrImageStorageFile.md) - - [AsposeEmailCloudSdk.models.AiNameComponentList](AiNameComponentList.md) - - [AsposeEmailCloudSdk.models.AiNameExtractedList](AiNameExtractedList.md) - - [AsposeEmailCloudSdk.models.AiNameGenderHypothesisList](AiNameGenderHypothesisList.md) - - [AsposeEmailCloudSdk.models.AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) - - [AsposeEmailCloudSdk.models.AlternateView](AlternateView.md) - - [AsposeEmailCloudSdk.models.Attachment](Attachment.md) - - [AsposeEmailCloudSdk.models.CalendarSaveRequest](CalendarSaveRequest.md) - - [AsposeEmailCloudSdk.models.CalendarStorageList](CalendarStorageList.md) - - [AsposeEmailCloudSdk.models.ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) - - [AsposeEmailCloudSdk.models.ClientAccountSaveRequest](ClientAccountSaveRequest.md) - - [AsposeEmailCloudSdk.models.ClientFolderCreateRequest](ClientFolderCreateRequest.md) - - [AsposeEmailCloudSdk.models.ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) - - [AsposeEmailCloudSdk.models.ClientMessageAppendRequest](ClientMessageAppendRequest.md) - - [AsposeEmailCloudSdk.models.ClientMessageBaseRequest](ClientMessageBaseRequest.md) - - [AsposeEmailCloudSdk.models.ClientMessageSendRequest](ClientMessageSendRequest.md) - - [AsposeEmailCloudSdk.models.ClientThreadBaseRequest](ClientThreadBaseRequest.md) - - [AsposeEmailCloudSdk.models.ContactList](ContactList.md) - - [AsposeEmailCloudSdk.models.ContactSaveRequest](ContactSaveRequest.md) - - [AsposeEmailCloudSdk.models.ContactStorageList](ContactStorageList.md) - - [AsposeEmailCloudSdk.models.DailyRecurrencePatternDto](DailyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.EmailAccountConfigList](EmailAccountConfigList.md) - - [AsposeEmailCloudSdk.models.EmailClientAccountOauthCredentials](EmailClientAccountOauthCredentials.md) - - [AsposeEmailCloudSdk.models.EmailClientAccountPasswordCredentials](EmailClientAccountPasswordCredentials.md) - - [AsposeEmailCloudSdk.models.EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) - - [AsposeEmailCloudSdk.models.EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) - - [AsposeEmailCloudSdk.models.EmailList](EmailList.md) - - [AsposeEmailCloudSdk.models.EmailSaveRequest](EmailSaveRequest.md) - - [AsposeEmailCloudSdk.models.EmailStorageList](EmailStorageList.md) - - [AsposeEmailCloudSdk.models.EmailThreadList](EmailThreadList.md) - - [AsposeEmailCloudSdk.models.FileVersion](FileVersion.md) - - [AsposeEmailCloudSdk.models.LinkedResource](LinkedResource.md) - - [AsposeEmailCloudSdk.models.MailMessageBase64](MailMessageBase64.md) - - [AsposeEmailCloudSdk.models.MailMessageBaseList](MailMessageBaseList.md) - - [AsposeEmailCloudSdk.models.MailMessageDto](MailMessageDto.md) - - [AsposeEmailCloudSdk.models.MailMessageMapi](MailMessageMapi.md) - - [AsposeEmailCloudSdk.models.MailServerFolderList](MailServerFolderList.md) - - [AsposeEmailCloudSdk.models.MapiBinaryPropertyDto](MapiBinaryPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiBooleanPropertyDto](MapiBooleanPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarDailyRecurrencePatternDto](MapiCalendarDailyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarDto](MapiCalendarDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) - - [AsposeEmailCloudSdk.models.MapiCalendarWeeklyRecurrencePatternDto](MapiCalendarWeeklyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.MapiCalendarYearlyAndMonthlyRecurrencePatternDto](MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.MapiContactDto](MapiContactDto.md) - - [AsposeEmailCloudSdk.models.MapiContactPhotoDto](MapiContactPhotoDto.md) - - [AsposeEmailCloudSdk.models.MapiContactSaveRequest](MapiContactSaveRequest.md) - - [AsposeEmailCloudSdk.models.MapiDateTimePropertyDto](MapiDateTimePropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiFileAsPropertyDto](MapiFileAsPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiImportancePropertyDto](MapiImportancePropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiIntPropertyDto](MapiIntPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiKnownPropertyDescriptor](MapiKnownPropertyDescriptor.md) - - [AsposeEmailCloudSdk.models.MapiLegacyFreeBusyPropertyDto](MapiLegacyFreeBusyPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiMessageDto](MapiMessageDto.md) - - [AsposeEmailCloudSdk.models.MapiMessageSaveRequest](MapiMessageSaveRequest.md) - - [AsposeEmailCloudSdk.models.MapiMultiIntPropertyDto](MapiMultiIntPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiMultiStringPropertyDto](MapiMultiStringPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiPhysicalAddressIndexPropertyDto](MapiPhysicalAddressIndexPropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) - - [AsposeEmailCloudSdk.models.MapiResponseTypePropertyDto](MapiResponseTypePropertyDto.md) - - [AsposeEmailCloudSdk.models.MapiStringPropertyDto](MapiStringPropertyDto.md) - - [AsposeEmailCloudSdk.models.MonthlyRecurrencePatternDto](MonthlyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.StorageFileLocation](StorageFileLocation.md) - - [AsposeEmailCloudSdk.models.StorageFileLocationList](StorageFileLocationList.md) - - [AsposeEmailCloudSdk.models.TaskRegeneratingPatternDto](TaskRegeneratingPatternDto.md) - - [AsposeEmailCloudSdk.models.WeeklyRecurrencePatternDto](WeeklyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.YearlyRecurrencePatternDto](YearlyRecurrencePatternDto.md) - - [AsposeEmailCloudSdk.models.ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) - - [AsposeEmailCloudSdk.models.ClientMessageMoveRequest](ClientMessageMoveRequest.md) - - [AsposeEmailCloudSdk.models.ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) - - [AsposeEmailCloudSdk.models.ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) - - [AsposeEmailCloudSdk.models.ClientThreadMoveRequest](ClientThreadMoveRequest.md) - - [AsposeEmailCloudSdk.models.ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) - - [AsposeEmailCloudSdk.models.MapiPidLidPropertyDescriptor](MapiPidLidPropertyDescriptor.md) - - [AsposeEmailCloudSdk.models.MapiPidNamePropertyDescriptor](MapiPidNamePropertyDescriptor.md) - - [AsposeEmailCloudSdk.models.MapiPidTagPropertyDescriptor](MapiPidTagPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.AiBcrImage](AiBcrImage.md) +- [AsposeEmailCloudSdk.models.AiBcrOptions](AiBcrOptions.md) +- [AsposeEmailCloudSdk.models.AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) +- [AsposeEmailCloudSdk.models.AiNameComponent](AiNameComponent.md) +- [AsposeEmailCloudSdk.models.AiNameCulturalContext](AiNameCulturalContext.md) +- [AsposeEmailCloudSdk.models.AiNameExtracted](AiNameExtracted.md) +- [AsposeEmailCloudSdk.models.AiNameExtractedComponent](AiNameExtractedComponent.md) +- [AsposeEmailCloudSdk.models.AiNameFormatted](AiNameFormatted.md) +- [AsposeEmailCloudSdk.models.AiNameGenderHypothesis](AiNameGenderHypothesis.md) +- [AsposeEmailCloudSdk.models.AiNameMatchResult](AiNameMatchResult.md) +- [AsposeEmailCloudSdk.models.AiNameMismatch](AiNameMismatch.md) +- [AsposeEmailCloudSdk.models.AiNameParsedRequest](AiNameParsedRequest.md) +- [AsposeEmailCloudSdk.models.AiNameWeighted](AiNameWeighted.md) +- [AsposeEmailCloudSdk.models.AiNameWeightedVariants](AiNameWeightedVariants.md) +- [AsposeEmailCloudSdk.models.AssociatedPerson](AssociatedPerson.md) +- [AsposeEmailCloudSdk.models.AttachmentBase](AttachmentBase.md) +- [AsposeEmailCloudSdk.models.CalendarAsAlternateRequest](CalendarAsAlternateRequest.md) +- [AsposeEmailCloudSdk.models.CalendarAsFileRequest](CalendarAsFileRequest.md) +- [AsposeEmailCloudSdk.models.CalendarDto](CalendarDto.md) +- [AsposeEmailCloudSdk.models.CalendarReminder](CalendarReminder.md) +- [AsposeEmailCloudSdk.models.ClientAccountBaseRequest](ClientAccountBaseRequest.md) +- [AsposeEmailCloudSdk.models.ContactAsFileRequest](ContactAsFileRequest.md) +- [AsposeEmailCloudSdk.models.ContactDto](ContactDto.md) +- [AsposeEmailCloudSdk.models.ContactPhoto](ContactPhoto.md) +- [AsposeEmailCloudSdk.models.ContentType](ContentType.md) +- [AsposeEmailCloudSdk.models.ContentTypeParameter](ContentTypeParameter.md) +- [AsposeEmailCloudSdk.models.CustomerEvent](CustomerEvent.md) +- [AsposeEmailCloudSdk.models.DiscUsage](DiscUsage.md) +- [AsposeEmailCloudSdk.models.DiscoverEmailConfigRequest](DiscoverEmailConfigRequest.md) +- [AsposeEmailCloudSdk.models.EmailAccountConfig](EmailAccountConfig.md) +- [AsposeEmailCloudSdk.models.EmailAddress](EmailAddress.md) +- [AsposeEmailCloudSdk.models.EmailAsFileRequest](EmailAsFileRequest.md) +- [AsposeEmailCloudSdk.models.EmailClientAccount](EmailClientAccount.md) +- [AsposeEmailCloudSdk.models.EmailClientAccountCredentials](EmailClientAccountCredentials.md) +- [AsposeEmailCloudSdk.models.EmailClientMultiAccount](EmailClientMultiAccount.md) +- [AsposeEmailCloudSdk.models.EmailDto](EmailDto.md) +- [AsposeEmailCloudSdk.models.EmailThread](EmailThread.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfAssociatedPersonCategory](EnumWithCustomOfAssociatedPersonCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfEmailAddressCategory](EnumWithCustomOfEmailAddressCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfEventCategory](EnumWithCustomOfEventCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfInstantMessengerCategory](EnumWithCustomOfInstantMessengerCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfPhoneNumberCategory](EnumWithCustomOfPhoneNumberCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfPostalAddressCategory](EnumWithCustomOfPostalAddressCategory.md) +- [AsposeEmailCloudSdk.models.EnumWithCustomOfUrlCategory](EnumWithCustomOfUrlCategory.md) +- [AsposeEmailCloudSdk.models.Error](Error.md) +- [AsposeEmailCloudSdk.models.ErrorDetails](ErrorDetails.md) +- [AsposeEmailCloudSdk.models.FileVersions](FileVersions.md) +- [AsposeEmailCloudSdk.models.FilesList](FilesList.md) +- [AsposeEmailCloudSdk.models.FilesUploadResult](FilesUploadResult.md) +- [AsposeEmailCloudSdk.models.InstantMessengerAddress](InstantMessengerAddress.md) +- [AsposeEmailCloudSdk.models.ListResponseOfAiNameComponent](ListResponseOfAiNameComponent.md) +- [AsposeEmailCloudSdk.models.ListResponseOfAiNameExtracted](ListResponseOfAiNameExtracted.md) +- [AsposeEmailCloudSdk.models.ListResponseOfAiNameGenderHypothesis](ListResponseOfAiNameGenderHypothesis.md) +- [AsposeEmailCloudSdk.models.ListResponseOfContactDto](ListResponseOfContactDto.md) +- [AsposeEmailCloudSdk.models.ListResponseOfEmailAccountConfig](ListResponseOfEmailAccountConfig.md) +- [AsposeEmailCloudSdk.models.ListResponseOfEmailDto](ListResponseOfEmailDto.md) +- [AsposeEmailCloudSdk.models.ListResponseOfEmailThread](ListResponseOfEmailThread.md) +- [AsposeEmailCloudSdk.models.ListResponseOfMailMessageBase](ListResponseOfMailMessageBase.md) +- [AsposeEmailCloudSdk.models.ListResponseOfMailServerFolder](ListResponseOfMailServerFolder.md) +- [AsposeEmailCloudSdk.models.ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) +- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfCalendarDto](ListResponseOfStorageModelOfCalendarDto.md) +- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfContactDto](ListResponseOfStorageModelOfContactDto.md) +- [AsposeEmailCloudSdk.models.ListResponseOfStorageModelOfEmailDto](ListResponseOfStorageModelOfEmailDto.md) +- [AsposeEmailCloudSdk.models.MailAddress](MailAddress.md) +- [AsposeEmailCloudSdk.models.MailMessageBase](MailMessageBase.md) +- [AsposeEmailCloudSdk.models.MailServerFolder](MailServerFolder.md) +- [AsposeEmailCloudSdk.models.MapiAttachmentDto](MapiAttachmentDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarAsFileRequest](MapiCalendarAsFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiCalendarAttendeesDto](MapiCalendarAttendeesDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarEventRecurrenceDto](MapiCalendarEventRecurrenceDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarExceptionInfoDto](MapiCalendarExceptionInfoDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarRecurrencePatternDto](MapiCalendarRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneDto](MapiCalendarTimeZoneDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneInfoDto](MapiCalendarTimeZoneInfoDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarTimeZoneRuleDto](MapiCalendarTimeZoneRuleDto.md) +- [AsposeEmailCloudSdk.models.MapiContactAsFileRequest](MapiContactAsFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiContactElectronicAddressDto](MapiContactElectronicAddressDto.md) +- [AsposeEmailCloudSdk.models.MapiContactElectronicAddressPropertySetDto](MapiContactElectronicAddressPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactEventPropertySetDto](MapiContactEventPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactNamePropertySetDto](MapiContactNamePropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactOtherPropertySetDto](MapiContactOtherPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactPersonalInfoPropertySetDto](MapiContactPersonalInfoPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressDto](MapiContactPhysicalAddressDto.md) +- [AsposeEmailCloudSdk.models.MapiContactPhysicalAddressPropertySetDto](MapiContactPhysicalAddressPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactProfessionalPropertySetDto](MapiContactProfessionalPropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiContactTelephonePropertySetDto](MapiContactTelephonePropertySetDto.md) +- [AsposeEmailCloudSdk.models.MapiElectronicAddressDto](MapiElectronicAddressDto.md) +- [AsposeEmailCloudSdk.models.MapiMessageAsFileRequest](MapiMessageAsFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiMessageItemBaseDto](MapiMessageItemBaseDto.md) +- [AsposeEmailCloudSdk.models.MapiPropertyDescriptor](MapiPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.MapiPropertyDto](MapiPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiRecipientDto](MapiRecipientDto.md) +- [AsposeEmailCloudSdk.models.NameValuePair](NameValuePair.md) +- [AsposeEmailCloudSdk.models.ObjectExist](ObjectExist.md) +- [AsposeEmailCloudSdk.models.PhoneNumber](PhoneNumber.md) +- [AsposeEmailCloudSdk.models.PostalAddress](PostalAddress.md) +- [AsposeEmailCloudSdk.models.RecurrencePatternDto](RecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.ReminderAttendee](ReminderAttendee.md) +- [AsposeEmailCloudSdk.models.ReminderTrigger](ReminderTrigger.md) +- [AsposeEmailCloudSdk.models.StorageExist](StorageExist.md) +- [AsposeEmailCloudSdk.models.StorageFile](StorageFile.md) +- [AsposeEmailCloudSdk.models.StorageFolderLocation](StorageFolderLocation.md) +- [AsposeEmailCloudSdk.models.StorageModelOfCalendarDto](StorageModelOfCalendarDto.md) +- [AsposeEmailCloudSdk.models.StorageModelOfContactDto](StorageModelOfContactDto.md) +- [AsposeEmailCloudSdk.models.StorageModelOfEmailClientAccount](StorageModelOfEmailClientAccount.md) +- [AsposeEmailCloudSdk.models.StorageModelOfEmailClientMultiAccount](StorageModelOfEmailClientMultiAccount.md) +- [AsposeEmailCloudSdk.models.StorageModelOfEmailDto](StorageModelOfEmailDto.md) +- [AsposeEmailCloudSdk.models.StorageModelOfMapiCalendarDto](StorageModelOfMapiCalendarDto.md) +- [AsposeEmailCloudSdk.models.StorageModelOfMapiContactDto](StorageModelOfMapiContactDto.md) +- [AsposeEmailCloudSdk.models.StorageModelOfMapiMessageDto](StorageModelOfMapiMessageDto.md) +- [AsposeEmailCloudSdk.models.Url](Url.md) +- [AsposeEmailCloudSdk.models.ValueTOfBoolean](ValueTOfBoolean.md) +- [AsposeEmailCloudSdk.models.ValueTOfString](ValueTOfString.md) +- [AsposeEmailCloudSdk.models.AiBcrImageStorageFile](AiBcrImageStorageFile.md) +- [AsposeEmailCloudSdk.models.AiNameComponentList](AiNameComponentList.md) +- [AsposeEmailCloudSdk.models.AiNameExtractedList](AiNameExtractedList.md) +- [AsposeEmailCloudSdk.models.AiNameGenderHypothesisList](AiNameGenderHypothesisList.md) +- [AsposeEmailCloudSdk.models.AiNameMatchParsedRequest](AiNameMatchParsedRequest.md) +- [AsposeEmailCloudSdk.models.AlternateView](AlternateView.md) +- [AsposeEmailCloudSdk.models.Attachment](Attachment.md) +- [AsposeEmailCloudSdk.models.CalendarSaveRequest](CalendarSaveRequest.md) +- [AsposeEmailCloudSdk.models.CalendarStorageList](CalendarStorageList.md) +- [AsposeEmailCloudSdk.models.ClientAccountSaveMultiRequest](ClientAccountSaveMultiRequest.md) +- [AsposeEmailCloudSdk.models.ClientAccountSaveRequest](ClientAccountSaveRequest.md) +- [AsposeEmailCloudSdk.models.ClientFolderCreateRequest](ClientFolderCreateRequest.md) +- [AsposeEmailCloudSdk.models.ClientFolderDeleteRequest](ClientFolderDeleteRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageAppendRequest](ClientMessageAppendRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageBaseRequest](ClientMessageBaseRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageSendRequest](ClientMessageSendRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadBaseRequest](ClientThreadBaseRequest.md) +- [AsposeEmailCloudSdk.models.ContactList](ContactList.md) +- [AsposeEmailCloudSdk.models.ContactSaveRequest](ContactSaveRequest.md) +- [AsposeEmailCloudSdk.models.ContactStorageList](ContactStorageList.md) +- [AsposeEmailCloudSdk.models.DailyRecurrencePatternDto](DailyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.EmailAccountConfigList](EmailAccountConfigList.md) +- [AsposeEmailCloudSdk.models.EmailClientAccountOauthCredentials](EmailClientAccountOauthCredentials.md) +- [AsposeEmailCloudSdk.models.EmailClientAccountPasswordCredentials](EmailClientAccountPasswordCredentials.md) +- [AsposeEmailCloudSdk.models.EmailConfigDiscoverOauthRequest](EmailConfigDiscoverOauthRequest.md) +- [AsposeEmailCloudSdk.models.EmailConfigDiscoverPasswordRequest](EmailConfigDiscoverPasswordRequest.md) +- [AsposeEmailCloudSdk.models.EmailList](EmailList.md) +- [AsposeEmailCloudSdk.models.EmailSaveRequest](EmailSaveRequest.md) +- [AsposeEmailCloudSdk.models.EmailStorageList](EmailStorageList.md) +- [AsposeEmailCloudSdk.models.EmailThreadList](EmailThreadList.md) +- [AsposeEmailCloudSdk.models.FileVersion](FileVersion.md) +- [AsposeEmailCloudSdk.models.LinkedResource](LinkedResource.md) +- [AsposeEmailCloudSdk.models.MailMessageBase64](MailMessageBase64.md) +- [AsposeEmailCloudSdk.models.MailMessageBaseList](MailMessageBaseList.md) +- [AsposeEmailCloudSdk.models.MailMessageDto](MailMessageDto.md) +- [AsposeEmailCloudSdk.models.MailMessageMapi](MailMessageMapi.md) +- [AsposeEmailCloudSdk.models.MailServerFolderList](MailServerFolderList.md) +- [AsposeEmailCloudSdk.models.MapiBinaryPropertyDto](MapiBinaryPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiBooleanPropertyDto](MapiBooleanPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarDailyRecurrencePatternDto](MapiCalendarDailyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarDto](MapiCalendarDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarSaveRequest](MapiCalendarSaveRequest.md) +- [AsposeEmailCloudSdk.models.MapiCalendarWeeklyRecurrencePatternDto](MapiCalendarWeeklyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.MapiCalendarYearlyAndMonthlyRecurrencePatternDto](MapiCalendarYearlyAndMonthlyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.MapiContactDto](MapiContactDto.md) +- [AsposeEmailCloudSdk.models.MapiContactPhotoDto](MapiContactPhotoDto.md) +- [AsposeEmailCloudSdk.models.MapiContactSaveRequest](MapiContactSaveRequest.md) +- [AsposeEmailCloudSdk.models.MapiDateTimePropertyDto](MapiDateTimePropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiFileAsPropertyDto](MapiFileAsPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiImportancePropertyDto](MapiImportancePropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiIntPropertyDto](MapiIntPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiKnownPropertyDescriptor](MapiKnownPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.MapiLegacyFreeBusyPropertyDto](MapiLegacyFreeBusyPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiMessageDto](MapiMessageDto.md) +- [AsposeEmailCloudSdk.models.MapiMessageSaveRequest](MapiMessageSaveRequest.md) +- [AsposeEmailCloudSdk.models.MapiMultiIntPropertyDto](MapiMultiIntPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiMultiStringPropertyDto](MapiMultiStringPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiPhysicalAddressIndexPropertyDto](MapiPhysicalAddressIndexPropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiPidPropertyDescriptor](MapiPidPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.MapiResponseTypePropertyDto](MapiResponseTypePropertyDto.md) +- [AsposeEmailCloudSdk.models.MapiStringPropertyDto](MapiStringPropertyDto.md) +- [AsposeEmailCloudSdk.models.MonthlyRecurrencePatternDto](MonthlyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.StorageFileLocation](StorageFileLocation.md) +- [AsposeEmailCloudSdk.models.StorageFileLocationList](StorageFileLocationList.md) +- [AsposeEmailCloudSdk.models.TaskRegeneratingPatternDto](TaskRegeneratingPatternDto.md) +- [AsposeEmailCloudSdk.models.WeeklyRecurrencePatternDto](WeeklyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.YearlyRecurrencePatternDto](YearlyRecurrencePatternDto.md) +- [AsposeEmailCloudSdk.models.ClientMessageDeleteRequest](ClientMessageDeleteRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageMoveRequest](ClientMessageMoveRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageSetIsReadRequest](ClientMessageSetIsReadRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadDeleteRequest](ClientThreadDeleteRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadMoveRequest](ClientThreadMoveRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadSetIsReadRequest](ClientThreadSetIsReadRequest.md) +- [AsposeEmailCloudSdk.models.MapiPidLidPropertyDescriptor](MapiPidLidPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.MapiPidNamePropertyDescriptor](MapiPidNamePropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.MapiPidTagPropertyDescriptor](MapiPidTagPropertyDescriptor.md) +- [AsposeEmailCloudSdk.models.AiBcrParseRequest](AiBcrParseRequest.md) +- [AsposeEmailCloudSdk.models.AiNameCompleteRequest](AiNameCompleteRequest.md) +- [AsposeEmailCloudSdk.models.AiNameExpandRequest](AiNameExpandRequest.md) +- [AsposeEmailCloudSdk.models.AiNameFormatRequest](AiNameFormatRequest.md) +- [AsposeEmailCloudSdk.models.AiNameGenderizeRequest](AiNameGenderizeRequest.md) +- [AsposeEmailCloudSdk.models.AiNameMatchRequest](AiNameMatchRequest.md) +- [AsposeEmailCloudSdk.models.AiNameParseRequest](AiNameParseRequest.md) +- [AsposeEmailCloudSdk.models.AiNameParseEmailAddressRequest](AiNameParseEmailAddressRequest.md) +- [AsposeEmailCloudSdk.models.CalendarConvertRequest](CalendarConvertRequest.md) +- [AsposeEmailCloudSdk.models.CalendarFromFileRequest](CalendarFromFileRequest.md) +- [AsposeEmailCloudSdk.models.CalendarGetRequest](CalendarGetRequest.md) +- [AsposeEmailCloudSdk.models.CalendarGetAsAlternateRequest](CalendarGetAsAlternateRequest.md) +- [AsposeEmailCloudSdk.models.CalendarGetAsFileRequest](CalendarGetAsFileRequest.md) +- [AsposeEmailCloudSdk.models.CalendarGetListRequest](CalendarGetListRequest.md) +- [AsposeEmailCloudSdk.models.ClientAccountGetRequest](ClientAccountGetRequest.md) +- [AsposeEmailCloudSdk.models.ClientAccountGetMultiRequest](ClientAccountGetMultiRequest.md) +- [AsposeEmailCloudSdk.models.ClientFolderGetListRequest](ClientFolderGetListRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageAppendFileRequest](ClientMessageAppendFileRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageFetchRequest](ClientMessageFetchRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageFetchFileRequest](ClientMessageFetchFileRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageListRequest](ClientMessageListRequest.md) +- [AsposeEmailCloudSdk.models.ClientMessageSendFileRequest](ClientMessageSendFileRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadGetListRequest](ClientThreadGetListRequest.md) +- [AsposeEmailCloudSdk.models.ClientThreadGetMessagesRequest](ClientThreadGetMessagesRequest.md) +- [AsposeEmailCloudSdk.models.ContactConvertRequest](ContactConvertRequest.md) +- [AsposeEmailCloudSdk.models.ContactFromFileRequest](ContactFromFileRequest.md) +- [AsposeEmailCloudSdk.models.ContactGetRequest](ContactGetRequest.md) +- [AsposeEmailCloudSdk.models.ContactGetAsFileRequest](ContactGetAsFileRequest.md) +- [AsposeEmailCloudSdk.models.ContactGetListRequest](ContactGetListRequest.md) +- [AsposeEmailCloudSdk.models.DisposableEmailIsDisposableRequest](DisposableEmailIsDisposableRequest.md) +- [AsposeEmailCloudSdk.models.EmailConvertRequest](EmailConvertRequest.md) +- [AsposeEmailCloudSdk.models.EmailFromFileRequest](EmailFromFileRequest.md) +- [AsposeEmailCloudSdk.models.EmailGetRequest](EmailGetRequest.md) +- [AsposeEmailCloudSdk.models.EmailGetAsFileRequest](EmailGetAsFileRequest.md) +- [AsposeEmailCloudSdk.models.EmailGetListRequest](EmailGetListRequest.md) +- [AsposeEmailCloudSdk.models.EmailConfigDiscoverRequest](EmailConfigDiscoverRequest.md) +- [AsposeEmailCloudSdk.models.CopyFileRequest](CopyFileRequest.md) +- [AsposeEmailCloudSdk.models.DeleteFileRequest](DeleteFileRequest.md) +- [AsposeEmailCloudSdk.models.DownloadFileRequest](DownloadFileRequest.md) +- [AsposeEmailCloudSdk.models.MoveFileRequest](MoveFileRequest.md) +- [AsposeEmailCloudSdk.models.UploadFileRequest](UploadFileRequest.md) +- [AsposeEmailCloudSdk.models.CopyFolderRequest](CopyFolderRequest.md) +- [AsposeEmailCloudSdk.models.CreateFolderRequest](CreateFolderRequest.md) +- [AsposeEmailCloudSdk.models.DeleteFolderRequest](DeleteFolderRequest.md) +- [AsposeEmailCloudSdk.models.GetFilesListRequest](GetFilesListRequest.md) +- [AsposeEmailCloudSdk.models.MoveFolderRequest](MoveFolderRequest.md) +- [AsposeEmailCloudSdk.models.MapiCalendarFromFileRequest](MapiCalendarFromFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiCalendarGetRequest](MapiCalendarGetRequest.md) +- [AsposeEmailCloudSdk.models.MapiContactFromFileRequest](MapiContactFromFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiContactGetRequest](MapiContactGetRequest.md) +- [AsposeEmailCloudSdk.models.MapiMessageFromFileRequest](MapiMessageFromFileRequest.md) +- [AsposeEmailCloudSdk.models.MapiMessageGetRequest](MapiMessageGetRequest.md) +- [AsposeEmailCloudSdk.models.GetDiscUsageRequest](GetDiscUsageRequest.md) +- [AsposeEmailCloudSdk.models.GetFileVersionsRequest](GetFileVersionsRequest.md) +- [AsposeEmailCloudSdk.models.ObjectExistsRequest](ObjectExistsRequest.md) +- [AsposeEmailCloudSdk.models.StorageExistsRequest](StorageExistsRequest.md) diff --git a/sdk/docs/MonthlyRecurrencePatternDto.md b/sdk/docs/MonthlyRecurrencePatternDto.md index d25b503..3de37d3 100644 --- a/sdk/docs/MonthlyRecurrencePatternDto.md +++ b/sdk/docs/MonthlyRecurrencePatternDto.md @@ -1,13 +1,26 @@ # AsposeEmailCloudSdk.models.MonthlyRecurrencePatternDto + +Monthly recurrence pattern. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**start_day** | **str** | Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**start_offset** | **int** | Start offset. | -**start_position** | **str** | Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | +**start_day** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | +**start_offset** |**int** |Start offset. | +**start_position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) +Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +monthly_recurrence_pattern_dto = models.MonthlyRecurrencePatternDto( + start_day='Monday', + start_position='First', + interval=-1, + week_start='Monday') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/MoveFileRequest.md b/sdk/docs/MoveFileRequest.md new file mode 100644 index 0000000..797a634 --- /dev/null +++ b/sdk/docs/MoveFileRequest.md @@ -0,0 +1,22 @@ +# MoveFileRequest + +Request model for FileApi.move_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**src_path** |**str** |Source file path e.g. '/src.ext' | +**dest_path** |**str** |Destination file path e.g. '/dest.ext' | +**src_storage_name** |**str** |Source storage name |[optional] +**dest_storage_name** |**str** |Destination storage name |[optional] +**version_id** |**str** |File version ID to move |[optional] + +## Example +```python +request = models.MoveFileRequest( + src_path='/storage/path/to/source/file.ext', + dest_path='/storage/path/to/destination/file.ext', + src_storage_name='First Storage', + dest_storage_name='Other Storage') +``` diff --git a/sdk/docs/MoveFolderRequest.md b/sdk/docs/MoveFolderRequest.md new file mode 100644 index 0000000..208b3be --- /dev/null +++ b/sdk/docs/MoveFolderRequest.md @@ -0,0 +1,21 @@ +# MoveFolderRequest + +Request model for FolderApi.move_folder + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**src_path** |**str** |Folder path to move e.g. '/folder' | +**dest_path** |**str** |Destination folder path to move to e.g '/dst' | +**src_storage_name** |**str** |Source storage name |[optional] +**dest_storage_name** |**str** |Destination storage name |[optional] + +## Example +```python +request = models.MoveFolderRequest( + src_path='/storage/path/to/source/folder', + dest_path='/storage/path/to/destination/folder', + src_storage_name='First Storage', + dest_storage_name='Other Storage') +``` diff --git a/sdk/docs/NameValuePair.md b/sdk/docs/NameValuePair.md index eee0cee..09f5020 100644 --- a/sdk/docs/NameValuePair.md +++ b/sdk/docs/NameValuePair.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.NameValuePair + +Name-Value property + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Property name | [optional] -**value** | **str** | Property value | [optional] +**name** |**str** |Property name |[optional] +**value** |**str** |Property value |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +name_value_pair = models.NameValuePair( + name='name', + value='value') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ObjectExist.md b/sdk/docs/ObjectExist.md index b9d7c55..6e30a98 100644 --- a/sdk/docs/ObjectExist.md +++ b/sdk/docs/ObjectExist.md @@ -1,12 +1,21 @@ # AsposeEmailCloudSdk.models.ObjectExist + +Object exists + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exists** | **bool** | Indicates that the file or folder exists. | -**is_folder** | **bool** | True if it is a folder, false if it is a file. | +**exists** |**bool** |Indicates that the file or folder exists. | +**is_folder** |**bool** |True if it is a folder, false if it is a file. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +object_exist = models.ObjectExist( + exists=True) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ObjectExistsRequest.md b/sdk/docs/ObjectExistsRequest.md new file mode 100644 index 0000000..cfd9435 --- /dev/null +++ b/sdk/docs/ObjectExistsRequest.md @@ -0,0 +1,18 @@ +# ObjectExistsRequest + +Request model for StorageApi.object_exists + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |File or folder path e.g. '/file.ext' or '/folder' | +**storage_name** |**str** |Storage name |[optional] +**version_id** |**str** |File version ID |[optional] + +## Example +```python +request = models.ObjectExistsRequest( + path='/storage/path/to/folder/or/file.ext', + storage_name='First Storage') +``` diff --git a/sdk/docs/PhoneNumber.md b/sdk/docs/PhoneNumber.md index a98e2d5..d291232 100644 --- a/sdk/docs/PhoneNumber.md +++ b/sdk/docs/PhoneNumber.md @@ -1,13 +1,25 @@ # AsposeEmailCloudSdk.models.PhoneNumber + +A phone number. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [**EnumWithCustomOfPhoneNumberCategory**](EnumWithCustomOfPhoneNumberCategory.md) | Phone number category. | [optional] -**number** | **str** | Phone number. | [optional] -**preferred** | **bool** | Defines whether phone number is preferred. | +**category** |[**EnumWithCustomOfPhoneNumberCategory**](EnumWithCustomOfPhoneNumberCategory.md) |Phone number category. |[optional] +**number** |**str** |Phone number. |[optional] +**preferred** |**bool** |Defines whether phone number is preferred. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +phone_number = models.PhoneNumber( + category=models.EnumWithCustomOfPhoneNumberCategory( + value='Company'), + number='+44 141 628 8900', + preferred=True) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/PostalAddress.md b/sdk/docs/PostalAddress.md index 8f4be87..2e50bf0 100644 --- a/sdk/docs/PostalAddress.md +++ b/sdk/docs/PostalAddress.md @@ -1,21 +1,38 @@ # AsposeEmailCloudSdk.models.PostalAddress + +A postal address + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address** | **str** | Address. | [optional] -**category** | [**EnumWithCustomOfPostalAddressCategory**](EnumWithCustomOfPostalAddressCategory.md) | Address category. | [optional] -**city** | **str** | Address's city. | [optional] -**country** | **str** | Address's country. | [optional] -**country_code** | **str** | Country code. | [optional] -**is_mailing_address** | **bool** | Defines whether address may be used for mailing. | -**postal_code** | **str** | Postal code. | [optional] -**post_office_box** | **str** | Post Office box. | [optional] -**preferred** | **bool** | Defines whether postal address is preferred. | -**state_or_province** | **str** | Address's region. | [optional] -**street** | **str** | Address's street. | [optional] +**address** |**str** |Address. |[optional] +**category** |[**EnumWithCustomOfPostalAddressCategory**](EnumWithCustomOfPostalAddressCategory.md) |Address category. |[optional] +**city** |**str** |Address's city. |[optional] +**country** |**str** |Address's country. |[optional] +**country_code** |**str** |Country code. |[optional] +**is_mailing_address** |**bool** |Defines whether address may be used for mailing. | +**postal_code** |**str** |Postal code. |[optional] +**post_office_box** |**str** |Post Office box. |[optional] +**preferred** |**bool** |Defines whether postal address is preferred. | +**state_or_province** |**str** |Address's region. |[optional] +**street** |**str** |Address's street. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +postal_address = models.PostalAddress( + address='221b', + category=models.EnumWithCustomOfPostalAddressCategory( + ), + city='London', + country='United Kingdom', + is_mailing_address=True, + postal_code='NW1 6XE', + preferred=True, + street='Baker St') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/RecurrencePatternDto.md b/sdk/docs/RecurrencePatternDto.md index 3450928..e3f972b 100644 --- a/sdk/docs/RecurrencePatternDto.md +++ b/sdk/docs/RecurrencePatternDto.md @@ -1,15 +1,25 @@ # AsposeEmailCloudSdk.models.RecurrencePatternDto + +iCalendar recurrence pattern. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**interval** | **int** | Number of recurrence units. | -**occurs** | **int** | Number of occurrences of the recurrence pattern. | -**end_date** | **datetime** | End date. | -**week_start** | **str** | Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**discriminator** | **str** | | +**interval** |**int** |Number of recurrence units. | +**occurs** |**int** |Number of occurrences of the recurrence pattern. | +**end_date** |**datetime** |End date. | +**week_start** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | +**discriminator** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +recurrence_pattern_dto = models.RecurrencePatternDto( + interval=-1, + week_start='Monday') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ReminderAttendee.md b/sdk/docs/ReminderAttendee.md index 4986565..35b4f76 100644 --- a/sdk/docs/ReminderAttendee.md +++ b/sdk/docs/ReminderAttendee.md @@ -1,11 +1,20 @@ # AsposeEmailCloudSdk.models.ReminderAttendee + +Defines an \"Attendee\" within a alarm. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address** | **str** | Contains the email address. | +**address** |**str** |Contains the email address. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +reminder_attendee = models.ReminderAttendee( + address='attendee@aspose.com') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ReminderTrigger.md b/sdk/docs/ReminderTrigger.md index 2dfdc9c..98afc4b 100644 --- a/sdk/docs/ReminderTrigger.md +++ b/sdk/docs/ReminderTrigger.md @@ -1,13 +1,23 @@ # AsposeEmailCloudSdk.models.ReminderTrigger + +Specifies when an alarm will trigger. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_time** | **datetime** | A trigger set to an absolute date/time. | -**duration** | **int** | Specifies a relative time in ticks for the trigger of the alarm. | [optional] -**related** | **str** | Specify the relationship of the alarm trigger with respect to the start or end of the event. Enum, available values: Start, End | +**date_time** |**datetime** |A trigger set to an absolute date/time. | +**duration** |**int** |Specifies a relative time in ticks for the trigger of the alarm. |[optional] +**related** |**str** |Specify the relationship of the alarm trigger with respect to the start or end of the event. Enum, available values: Start, End | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +reminder_trigger = models.ReminderTrigger( + date_time=datetime.today(), + duration=600000000) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/StorageApi.md b/sdk/docs/StorageApi.md index b5d10de..0e63642 100644 --- a/sdk/docs/StorageApi.md +++ b/sdk/docs/StorageApi.md @@ -1,109 +1,289 @@ -# AsposeEmailCloudSdk.StorageApi +# AsposeEmailCloudSdk.StorageApi (EmailCloud.cloud_storage.storage) + +Storage operations controller - -# get_disc_usage +## get_disc_usage + +Description: Get disc usage + +Returns: Disc usage. +Method call example: ```python -get_disc_usage(self, request: GetDiscUsageRequest) +result = api.cloud_storage.storage.get_disc_usage(request) ``` -Get disc usage +### Parameter: request -### Return type +Description: get_disc_usage method request. -DiscUsage +See parameter model documentation at [GetDiscUsageRequest](GetDiscUsageRequest.md). -### request Parameter +
+ Parameter initialization example: + ```python -GetDiscUsageRequest( - storage_name) +request = models.GetDiscUsageRequest( + storage_name='First Storage') +``` + +
+ +### Result + +Description: Disc usage. + +Return type: [**DiscUsage**](DiscUsage.md) + +
+ Result example + +```python +result = models.DiscUsage( + used_size=1048576, + total_size=3145728) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.GetDiscUsageRequest( + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.storage.get_disc_usage(request) + +// Result example: +result = models.DiscUsage( + used_size=1048576, + total_size=3145728) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **storage_name** | **str** | Storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# get_file_versions +## get_file_versions +Description: Get file versions + +Returns: File versions. + +Method call example: ```python -get_file_versions(self, request: GetFileVersionsRequest) +result = api.cloud_storage.storage.get_file_versions(request) ``` -Get file versions +### Parameter: request + +Description: get_file_versions method request. + +See parameter model documentation at [GetFileVersionsRequest](GetFileVersionsRequest.md). + +
+ Parameter initialization example: + +```python +request = models.GetFileVersionsRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') +``` + +
+ +### Result -### Return type +Description: File versions. -FileVersions +Return type: [**FileVersions**](FileVersions.md) + +
+ Result example -### request Parameter ```python -GetFileVersionsRequest( - path, - storage_name) +result = models.FileVersions( + value=[ + models.FileVersion( + version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', + is_latest=True, + name='file.ext', + modified_date=datetime.today(), + size=4096, + path='/storage/path/to')]) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.GetFileVersionsRequest( + path='/storage/path/to/file.ext', + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.storage.get_file_versions(request) + +// Result example: +result = models.FileVersions( + value=[ + models.FileVersion( + version_id='d5afd857-8797-4ca0-b806-a03fdfc3831f', + is_latest=True, + name='file.ext', + modified_date=datetime.today(), + size=4096, + path='/storage/path/to')]) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | File path e.g. '/file.ext' | - **storage_name** | **str** | Storage name | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# object_exists +## object_exists +Description: Check if file or folder exists + +Returns: Object exist result. + +Method call example: ```python -object_exists(self, request: ObjectExistsRequest) +result = api.cloud_storage.storage.object_exists(request) ``` -Check if file or folder exists +### Parameter: request + +Description: object_exists method request. + +See parameter model documentation at [ObjectExistsRequest](ObjectExistsRequest.md). + +
+ Parameter initialization example: + +```python +request = models.ObjectExistsRequest( + path='/storage/path/to/folder/or/file.ext', + storage_name='First Storage') +``` + +
+ +### Result -### Return type +Description: Object exist result. -ObjectExist +Return type: [**ObjectExist**](ObjectExist.md) + +
+ Result example -### request Parameter ```python -ObjectExistsRequest( - path, - storage_name, - version_id) +result = models.ObjectExist( + exists=True) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.ObjectExistsRequest( + path='/storage/path/to/folder/or/file.ext', + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.storage.object_exists(request) + +// Result example: +result = models.ObjectExist( + exists=True) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str** | File or folder path e.g. '/file.ext' or '/folder' | - **storage_name** | **str** | Storage name | [optional] - **version_id** | **str** | File version ID | [optional] +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) - -# exists +## exists +Description: Check if storage exists + +Returns: Storage exist result. + +Method call example: ```python -exists(self, request: StorageExistsRequest) +result = api.cloud_storage.storage.exists(request) ``` -Check if storage exists +### Parameter: request + +Description: exists method request. + +See parameter model documentation at [StorageExistsRequest](StorageExistsRequest.md). + +
+ Parameter initialization example: + +```python +request = models.StorageExistsRequest( + storage_name='First Storage') +``` + +
+ +### Result -### Return type +Description: Storage exist result. -StorageExist +Return type: [**StorageExist**](StorageExist.md) + +
+ Result example -### request Parameter ```python -StorageExistsRequest( - storage_name) +result = models.StorageExist( + exists=True) +``` +
+ +### Complete example + +
+ Method call example: + +```python +api = EmailCloud(app_key, app_sid) + +// Prepare parameters: +request = models.StorageExistsRequest( + storage_name='First Storage') + +// Call method: +result = api.cloud_storage.storage.exists(request) + +// Result example: +result = models.StorageExist( + exists=True) ``` -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **storage_name** | **str** | Storage name | +
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageApi_list.md b/sdk/docs/StorageApi_list.md index 29212a2..c41850a 100644 --- a/sdk/docs/StorageApi_list.md +++ b/sdk/docs/StorageApi_list.md @@ -1,4 +1,3 @@ - ## Documentation for StorageApi operations All URIs are relative to *https://api.aspose.cloud/v4.0* diff --git a/sdk/docs/StorageExist.md b/sdk/docs/StorageExist.md index 6b55561..1b1607e 100644 --- a/sdk/docs/StorageExist.md +++ b/sdk/docs/StorageExist.md @@ -1,11 +1,20 @@ # AsposeEmailCloudSdk.models.StorageExist + +Storage exists + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exists** | **bool** | Shows that the storage exists. | +**exists** |**bool** |Shows that the storage exists. | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +storage_exist = models.StorageExist( + exists=True) +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/StorageExistsRequest.md b/sdk/docs/StorageExistsRequest.md new file mode 100644 index 0000000..5a99c63 --- /dev/null +++ b/sdk/docs/StorageExistsRequest.md @@ -0,0 +1,16 @@ +# StorageExistsRequest + +Request model for StorageApi.exists + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**storage_name** |**str** |Storage name | + +## Example +```python +request = models.StorageExistsRequest( + storage_name='First Storage') +``` + diff --git a/sdk/docs/StorageFile.md b/sdk/docs/StorageFile.md index cd85f6f..7f15d39 100644 --- a/sdk/docs/StorageFile.md +++ b/sdk/docs/StorageFile.md @@ -1,15 +1,27 @@ # AsposeEmailCloudSdk.models.StorageFile + +File or folder information + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | File or folder name. | [optional] -**is_folder** | **bool** | True if it is a folder. | -**modified_date** | **datetime** | File or folder last modified DateTime. | [optional] -**size** | **int** | File or folder size. | -**path** | **str** | File or folder path. | [optional] +**name** |**str** |File or folder name. |[optional] +**is_folder** |**bool** |True if it is a folder. | +**modified_date** |**datetime** |File or folder last modified DateTime. |[optional] +**size** |**int** |File or folder size. | +**path** |**str** |File or folder path. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +storage_file = models.StorageFile( + name='file.ext', + modified_date=datetime.today(), + size=4096, + path='/storage/path/to') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/StorageFileLocation.md b/sdk/docs/StorageFileLocation.md index 8b4b640..1728254 100644 --- a/sdk/docs/StorageFileLocation.md +++ b/sdk/docs/StorageFileLocation.md @@ -1,11 +1,23 @@ # AsposeEmailCloudSdk.models.StorageFileLocation + +A storage file location information + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file_name** | **str** | A file name in storage | +**file_name** |**str** |A file name in storage | - Parent class: [StorageFolderLocation](StorageFolderLocation.md) +Parent class: [StorageFolderLocation](StorageFolderLocation.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +storage_file_location = models.StorageFileLocation( + file_name='fileOnStorage.txt', + storage='First Storage', + folder_path='file/location/folder/on/storage') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageFileLocationList.md b/sdk/docs/StorageFileLocationList.md index 6ec1d8f..7c780fc 100644 --- a/sdk/docs/StorageFileLocationList.md +++ b/sdk/docs/StorageFileLocationList.md @@ -1,10 +1,24 @@ # AsposeEmailCloudSdk.models.StorageFileLocationList + +List of files located on storage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- - Parent class: [ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) +Parent class: [ListResponseOfStorageFileLocation](ListResponseOfStorageFileLocation.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +storage_file_location_list = models.StorageFileLocationList( + value=[ + models.StorageFileLocation( + file_name='fileOnStorage.txt', + storage='First Storage', + folder_path='file/location/folder/on/storage')]) +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageFolderLocation.md b/sdk/docs/StorageFolderLocation.md index 002cb01..cf4d129 100644 --- a/sdk/docs/StorageFolderLocation.md +++ b/sdk/docs/StorageFolderLocation.md @@ -1,12 +1,22 @@ # AsposeEmailCloudSdk.models.StorageFolderLocation + +A storage folder location information + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage** | **str** | A storage name | [optional] -**folder_path** | **str** | A path to a folder in specified storage | [optional] +**storage** |**str** |A storage name |[optional] +**folder_path** |**str** |A path to a folder in specified storage |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +storage_folder_location = models.StorageFolderLocation( + storage='First Storage', + folder_path='folder/on/storage') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/StorageModelOfCalendarDto.md b/sdk/docs/StorageModelOfCalendarDto.md index 82b547b..4a51445 100644 --- a/sdk/docs/StorageModelOfCalendarDto.md +++ b/sdk/docs/StorageModelOfCalendarDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfCalendarDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**CalendarDto**](CalendarDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**CalendarDto**](CalendarDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfContactDto.md b/sdk/docs/StorageModelOfContactDto.md index 31cd362..ef5bcbb 100644 --- a/sdk/docs/StorageModelOfContactDto.md +++ b/sdk/docs/StorageModelOfContactDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfContactDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**ContactDto**](ContactDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**ContactDto**](ContactDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfEmailClientAccount.md b/sdk/docs/StorageModelOfEmailClientAccount.md index e92102e..cb66694 100644 --- a/sdk/docs/StorageModelOfEmailClientAccount.md +++ b/sdk/docs/StorageModelOfEmailClientAccount.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfEmailClientAccount + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**EmailClientAccount**](EmailClientAccount.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**EmailClientAccount**](EmailClientAccount.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfEmailClientMultiAccount.md b/sdk/docs/StorageModelOfEmailClientMultiAccount.md index d972b8a..a0f281b 100644 --- a/sdk/docs/StorageModelOfEmailClientMultiAccount.md +++ b/sdk/docs/StorageModelOfEmailClientMultiAccount.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfEmailClientMultiAccount + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**EmailClientMultiAccount**](EmailClientMultiAccount.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**EmailClientMultiAccount**](EmailClientMultiAccount.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfEmailDto.md b/sdk/docs/StorageModelOfEmailDto.md index 9ecce13..0f740cb 100644 --- a/sdk/docs/StorageModelOfEmailDto.md +++ b/sdk/docs/StorageModelOfEmailDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfEmailDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**EmailDto**](EmailDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**EmailDto**](EmailDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfMapiCalendarDto.md b/sdk/docs/StorageModelOfMapiCalendarDto.md index c8acf3f..76635e3 100644 --- a/sdk/docs/StorageModelOfMapiCalendarDto.md +++ b/sdk/docs/StorageModelOfMapiCalendarDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfMapiCalendarDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**MapiCalendarDto**](MapiCalendarDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**MapiCalendarDto**](MapiCalendarDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfMapiContactDto.md b/sdk/docs/StorageModelOfMapiContactDto.md index 1b1d6df..8da6057 100644 --- a/sdk/docs/StorageModelOfMapiContactDto.md +++ b/sdk/docs/StorageModelOfMapiContactDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfMapiContactDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**MapiContactDto**](MapiContactDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**MapiContactDto**](MapiContactDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/StorageModelOfMapiMessageDto.md b/sdk/docs/StorageModelOfMapiMessageDto.md index da95392..79493cd 100644 --- a/sdk/docs/StorageModelOfMapiMessageDto.md +++ b/sdk/docs/StorageModelOfMapiMessageDto.md @@ -1,12 +1,13 @@ # AsposeEmailCloudSdk.models.StorageModelOfMapiMessageDto + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | | -**value** | [**MapiMessageDto**](MapiMessageDto.md) | | +**storage_file** |[**StorageFileLocation**](StorageFileLocation.md) | | +**value** |[**MapiMessageDto**](MapiMessageDto.md) | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/TaskRegeneratingPatternDto.md b/sdk/docs/TaskRegeneratingPatternDto.md index 349e3f4..9c6f4f0 100644 --- a/sdk/docs/TaskRegeneratingPatternDto.md +++ b/sdk/docs/TaskRegeneratingPatternDto.md @@ -1,11 +1,24 @@ # AsposeEmailCloudSdk.models.TaskRegeneratingPatternDto + +Represents the regenerating recurrence pattern that specifies how many days, weeks, months or years after the completion of the current task the next occurrence will be due. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**regenerating_type** | **str** | Enumerates the types of regenerating pattern. Enum, available values: Daily, Weekly, Monthly, Yearly | +**regenerating_type** |**str** |Enumerates the types of regenerating pattern. Enum, available values: Daily, Weekly, Monthly, Yearly | - Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) +Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +task_regenerating_pattern_dto = models.TaskRegeneratingPatternDto( + interval=1, + occurs=2, + end_date=datetime.today(), + week_start='Sunday') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/UploadFileRequest.md b/sdk/docs/UploadFileRequest.md new file mode 100644 index 0000000..071ab78 --- /dev/null +++ b/sdk/docs/UploadFileRequest.md @@ -0,0 +1,19 @@ +# UploadFileRequest + +Request model for FileApi.upload_file + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**path** |**str** |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. | +**file** |**str** |File to upload | +**storage_name** |**str** |Storage name |[optional] + +## Example +```python +request = models.UploadFileRequest( + path='/storage/path/to/file.ext', + file='/local/file/system/path/to/file.ext', + storage_name='First Storage') +``` diff --git a/sdk/docs/Url.md b/sdk/docs/Url.md index c1f8b60..468528c 100644 --- a/sdk/docs/Url.md +++ b/sdk/docs/Url.md @@ -1,13 +1,25 @@ # AsposeEmailCloudSdk.models.Url + +Url and its category. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [**EnumWithCustomOfUrlCategory**](EnumWithCustomOfUrlCategory.md) | Url category. | [optional] -**preferred** | **bool** | Defines whether url is preferred. | -**href** | **str** | URL. | [optional] +**category** |[**EnumWithCustomOfUrlCategory**](EnumWithCustomOfUrlCategory.md) |Url category. |[optional] +**preferred** |**bool** |Defines whether url is preferred. | +**href** |**str** |URL. |[optional] -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +url = models.Url( + category=models.EnumWithCustomOfUrlCategory( + value='Work'), + preferred=True, + href='https://products.aspose.cloud/email') +``` +[[Back to Model list]](Models.md) [[Back to README]](README.md) + diff --git a/sdk/docs/ValueTOfBoolean.md b/sdk/docs/ValueTOfBoolean.md index 32f991e..c6f4635 100644 --- a/sdk/docs/ValueTOfBoolean.md +++ b/sdk/docs/ValueTOfBoolean.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ValueTOfBoolean + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **bool** | | +**value** |**bool** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/ValueTOfString.md b/sdk/docs/ValueTOfString.md index 51c36d5..8f6fd64 100644 --- a/sdk/docs/ValueTOfString.md +++ b/sdk/docs/ValueTOfString.md @@ -1,11 +1,12 @@ # AsposeEmailCloudSdk.models.ValueTOfString + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **str** | | +**value** |**str** | | -[[Back to Model list]](Models.md) [[Back to README]](README.md) +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/WeeklyRecurrencePatternDto.md b/sdk/docs/WeeklyRecurrencePatternDto.md index 4d9e1b6..831421f 100644 --- a/sdk/docs/WeeklyRecurrencePatternDto.md +++ b/sdk/docs/WeeklyRecurrencePatternDto.md @@ -1,11 +1,26 @@ # AsposeEmailCloudSdk.models.WeeklyRecurrencePatternDto + +Weekly recurrence pattern. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**start_days** | **list[str]** | Start days Items: Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | [optional] +**start_days** |**list[str]** |Start days Items: Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay |[optional] - Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) +Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +weekly_recurrence_pattern_dto = models.WeeklyRecurrencePatternDto( + start_days=[ + 'Tuesday', + 'Thursday'], + interval=-1, + occurs=10, + week_start='Sunday') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/docs/YearlyRecurrencePatternDto.md b/sdk/docs/YearlyRecurrencePatternDto.md index 6a1832d..17e1a79 100644 --- a/sdk/docs/YearlyRecurrencePatternDto.md +++ b/sdk/docs/YearlyRecurrencePatternDto.md @@ -1,14 +1,27 @@ # AsposeEmailCloudSdk.models.YearlyRecurrencePatternDto + +Yearly recurrence pattern. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**start_day** | **str** | Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | -**start_month** | **str** | Represents a calendar month. Enum, available values: None, January, February, March, April, May, June, July, August, September, October, November, December | -**start_offset** | **int** | Start offset. | -**start_position** | **str** | Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | +**start_day** |**str** |Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay | +**start_month** |**str** |Represents a calendar month. Enum, available values: None, January, February, March, April, May, June, July, August, September, October, November, December | +**start_offset** |**int** |Start offset. | +**start_position** |**str** |Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last | - Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) +Parent class: [RecurrencePatternDto](RecurrencePatternDto.md) -[[Back to Model list]](Models.md) [[Back to README]](README.md) +## Example +```python +yearly_recurrence_pattern_dto = models.YearlyRecurrencePatternDto( + start_month='January', + start_offset=30, + interval=-1, + week_start='Monday') +``` + + +[[Back to Model list]](Models.md) [[Back to README]](README.md) diff --git a/sdk/setup.py b/sdk/setup.py index c520abb..7104065 100644 --- a/sdk/setup.py +++ b/sdk/setup.py @@ -8,7 +8,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "aspose-email-cloud" -VERSION = "20.9.1" +VERSION = "20.10.0.123" # To install the library, run the following # # python setup.py install