Show Hide

 

Feedback

  • Contents
  • Index
 

MIC Lookup Moniker

This tool searches the address book for the moniker (name) corresponding to the input address. The input can be one of several optional keys.  Pass in either a user object with one or more of the appropriate attributes, or one or more input (email) addresses, or some part of an IMAP address and this tool returns an ordered list of corresponding monikers. The moniker is the address MIC uses to open the message store. This tool is similar to the MIC Format Address tool.

Inputs

MIC Object

An (optional) MIC Object. One of the following attributes must be set on the user object to create an IMAP moniker:

  • _ImapHost

  • _ImapUserName

  • _ImapAuthorization (PROXYAUTH if empty)

  • _ImapEncryptionKey (cleartext if empty)

Input Addresses

(optional) – string or list of string. For example, "SMTP:Bill.Smith@company.com"

Per-Address Timeout (sec)

This optional (numeric) parameter specifies the number of seconds the tool waits before timing out on an address lookup.

Note: Exchange and Notes are the only two address types that are actually searched via an address book lookup, so this parameter only applies to these types.  The default value is the Post Office timeout value (which defaults to 30 seconds if not changed in Interaction Administrator – see the Mail Default Timeout server parameter).

IMAP Host [:port]

This optional string is the DNS name or IP address of the IMAP Host.

IMAP UserName

This optional string is the user id of the IMAP malbox.

IMAP Password (PROXYAUTH if empty)

This optional string is the password of the IMAP mailbox.  If this value is empty, proxy authentication (PROXYAUTH) is used.

IMAP Encryption Key (cleartext if empty)

This optional string is the AES encryption key of the password parameter above.  The IMAP Password parameter is considered to be in clear text if this value is empty.

Outputs

Monikers

A precedence ordered list of message store moniker strings (lsMonikers).  Any monikers that failed to be resolved will appear as an empty (“”) value in the output string list.

Precedence Ordering:

  1. Exchange

  2. Notes

  3. SMTP / IMAP

  4. FBMC (IMS)

Exit Code

An Exit Code (iExitCode) of 0 (zero) indicates success and a non-zero code indicates an error or other condition about the results of this tool step.

Exit Text

The exit text string (sExitText) corresponds to the Exit Code. When the Exit Code is 0, the Exit Text is "Success."

Exit Paths

Success

If it successfully searches and returns a moniker or empty string.

Failure

If the MIC object is out of scope or an invalid name. Some common error codes for this include:

Exit Code: 0x80070057

Exit Text: One or more arguments are invalid

Reason: No user object, input addresses, or IMAP host / IMAP user name were passed. The MIC Object passed was not a user object.

 

Related Topics

MIC Format Address