ImportFaxes

Imports the faxes from the Fax server into the document batch.

Member of namespace

OpenTextFaxServer

Syntax

bool ImportFaxes ()

Returns

False if the action is not called at the batch level or if an exception is encountered while importing faxes. Otherwise, True.

Level

Batch Level.

Details

This action imports faxes from the fax server. Each fax that is imported is stored in a document inside the Datacap batch. The following fax information will be stored in the document's variables (some of these variables can be empty):
  • FaxUniqueID
  • FaxStatus
  • TotalPages
  • LastHistoryChangeDateTime
  • FromFaxNumber
  • FromName
  • FromVoiceNumber
  • FromGeneralFaxNumber
  • FromGeneralVoiceNumber
  • Attachments
  • ToFaxNumber
  • ToVoiceNumber
Attention: Setting the batch variable WriteFaxXMLData to "1" causes the action to write all possible fax properties to an XML file. The XML is named based on the created document ID for a fax, for example, 20120109.000008.01.xml.

Include this action after a Connect() action.

Example
SetServerName("myserver")
SetUserID("myuser")
SetUserPassword("mypassword")
SetProtocol(4)
Connect()
ImportFaxes()
Note: If the Connect() action is not called prior to calling ImportFaxes(), ImportFaxes() automatically calls the Connect() action. However, the actions that set the connection parameters need to be called prior to ImportFaxes().
Parent topic: OpenTextFaxServer actions