Represents a Fax message within the Interaction Center system.

Namespace: ININ.IceLib.UnifiedMessaging
Assembly: ININ.IceLib.UnifiedMessaging (in ININ.IceLib.UnifiedMessaging.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public class FaxMessage : IDisposable
Visual Basic
Public Class FaxMessage _
	Implements IDisposable

Remarks

All FaxMessages are accessible through the Faxes property of the UnifiedMessagingManager instance. The Faxes list is not automatically kept current. It must be refreshed by calling RefreshFaxCache(Int32) or RefreshFaxCacheAsync(Int32, AsyncCompletedEventHandler, Object). In addition to referencing the entire list, code can be informed of changes to the list by subscribing to the NewFax, FaxDeleted, and FaxUpdated events.

A FaxMessage contains various pieces of information about the Fax itself (for example: From, To, Subject, Body), as well as a list of actual Fax file attachments to the FaxMessage. A FaxMessage may contain zero or more FaxAttachments (available from the Attachments property), each one representing a Fax file added to the Fax message at any given time. In typical scenarios there will only be one attachment which is the Fax itself, but it is possible for users to group several Fax files together into a single fax message.

Currently, FaxMessages may not be changed and saved.

Note
Although this is not typical, each FaxAttachment may not necessarily contain a Fax file. It is possible for a user to attach any file they wish to a FaxMessage.

Examples

The following example demonstrates saving a FaxAttachment to the file system.

CopyC#
...
UnifiedMessagingManager manager = UnifiedMessagingManager.GetInstance(_session);
manager.RefreshFaxCache(-1);
if (manager.Faxes.Count > 0)
{
    FaxMessage msg = manager.Faxes[0];
    if ((msg.Attachments.Count > 0) && (IsFaxFileExtension(msg.Attachments[0].Name))
    {
        string fileName = System.IO.Path.GetTempFileName();
        msg.SaveAsFile(msg.Attachments[0], fileName, true);
    }
}
...

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.UnifiedMessaging..::..FaxMessage

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also