External Agent COM API Reference Guide › API Interfaces: Generating EVF Files › COM object: WGNRDILib::WgnImportConnector › Interface IWgnImportConnector2 › Method ImportObject

Method ImportObject

Use this method to import a message.

HRESULT ImportObject(
    [in] WGN_IMPORTOBJ_TYPE       objectType,
    [in] WGN_IMPORTOBJ_FORMAT     objectFormat,
    [in] WGN_IMPORTOBJ_TRANSPORT  objectTransport,
    [in] VARIANT                  objectData,
    [in] BSTR                     messageID,
    [in] DWORD                    importSource,
    [in, out,unique] BSTR *       newMessageID,    /* OUT-ONLY */
    [in, out,unique] DWORD*       newImportSource  /* OUT-ONLY */
);

Where:

objectType

Specifies the type of object to import (e-mail or IM). For details, see the typedef WGN_IMPORTOBJ_TYPE.

objectFormat

Specifies the format of the object to import. For details, see the typedef WGN_IMPORTOBJ_FORMAT.

objectTransport

Specifies the method used to transfer data to the RDI. For details, see the typedef WGN_IMPORTOBJ_TRANSPORT.

objectData

Specifies the source data being imported.

messageID

Is a string that uniquely identifies the message in the archive. This will be the string given to CA's Remote Data Manager (RDM) to enable it to retrieve the message contents. But see the warning below.

Important!  messageID is critical! You can use any string as the identifier but it must be unique and the identifiers must be managed correctly to ensure that CA DataMinder can retrieve the full details for imported e-mails. Your application must be able to use this string, when called by the RDM, to access the exact same message.

importSource

Is the archive identifier.

newMessageID

Is not used in the current version of the RDI.

newImportSource

Is not used in the current version of the RDI.

Input combinations for ImportObject method

WgnRDI.dll does not support all message Format- Type-Transport permutations.

Return values for ImportObject method

E_INVALIDARG 0x80070057

Indicates that an invalid argument was passed to the method.

0xE5630D2E

Indicates an unknown import source. This value is returned if the importSource parameter is set to an invalid number.

0xE5630D18

"A mail event could not be created because the available disk space was less than the configured threshold."

This error message may indicate that the cache is not being cleared quickly enough. If you get this error, wait before retrying to import the e-mail. If you continue to get this error, then you must halt the archive process and flag an alert.

More information:

Input Combinations for ImportObject() Method

Values for importSource