Cloud Mail 2020 Node.js Edition

Questions / Feedback?

ListIdentities Method

Lists the identities of the given type.

Syntax

amazonses.listIdentities(identityType, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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 IdentityName property will contain the identity for each result. The IdentityList 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 IdentityMarker property will be populated. To obtain the next page of results simply call ListIdentities again. The IdentityMarker value determines the results offset. On the last page of results the IsPaged configuration setting will return "False" and IdentityMarker will be set to empty string. With this design to get all of the results you can repeatedly call ListIdentities until IsPaged returns "False" or IdentityMarker is set to empty string.

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