Cloud Mail 2020 Python Edition

Questions / Feedback?

list_identities Method

Lists the identities of the given type.

Syntax

def list_identities(identity_type: int) -> None: ...

Remarks

This method is used to list the identities of the specified type. The IdentityType parameter specifies the type of identities you wish to list. Possible values are:

IdentityTypeMeaning
0Email
1Domain
2Both Email and Domain

The identities property will be populated with the results. The identity_name property will contain the identity for each result. The on_identity_list event will also fire for each result.

If the number of results exceeds MaxListIdentityResults the results will be paged. When the results are paged the IsPaged setting will return "True" and the identity_marker property will be populated. To obtain the next page of results simply call on_list_identities again. The identity_marker value determines the results offset. On the last page of results the IsPaged configuration setting will return "False" and identity_marker will be set to empty string. With this design to get all of the results you can repeatedly call on_list_identities until IsPaged returns "False" or identity_marker is set to empty string.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Python Edition - Version 20.0 [Build 7718]