Stores information related to the delivery of a Fax file.
Namespace: ININ.IceLib.UnifiedMessagingAssembly: ININ.IceLib.UnifiedMessaging (in ININ.IceLib.UnifiedMessaging.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
| C# |
|---|
public class FaxEnvelope : ICloneable |
| Visual Basic |
|---|
Public Class FaxEnvelope _ Implements ICloneable |
Remarks
Use the FaxEnvelope class to define the recipient and delivery
options for a Fax. You can specify who receives a fax, when it
should be delivered, what type of cover page it should have, and who should be
notified after a send attempt. Where the FaxFile class defines the content
of a Fax, the FaxEnvelope defines all aspects of its delivery.
A FaxEnvelope is logically divided into a CoverPage, a Schedule, a Recipient, Options, and Notification preferences. When creating a new FaxEnvelope, these properties are all assigned default values that will allow a Fax to be successfully delivered with the exception of the Recipient. You must assign a number to the Fax property of the Recipient in order to have a destination for this envelope.
In addition to providing an actual Fax number, you must assign a valid IC user name to the SenderId. You should also set the TimeSent to indicate when the envelope was finalized for delivery.
The Fax delivery will fail if a SenderId is not provided or if the Fax property is not set.
 Note |
|---|
| Each FaxEnvelope added to a FaxFile represents a single addressee that will receive the Fax. If you will be sending a fax to multiple recipients, you must create a FaxEnvelope for each recipient. |
A FaxEnvelope is logically divided into a CoverPage, a Schedule, a Recipient, Options, and Notification preferences. When creating a new FaxEnvelope, these properties are all assigned default values that will allow a Fax to be successfully delivered with the exception of the Recipient. You must assign a number to the Fax property of the Recipient in order to have a destination for this envelope.
In addition to providing an actual Fax number, you must assign a valid IC user name to the SenderId. You should also set the TimeSent to indicate when the envelope was finalized for delivery.
The Fax delivery will fail if a SenderId is not provided or if the Fax property is not set.
Examples
The following example demonstrates the creation of a default envelope and assignment of a
SenderId and Fax number.
CopyC#
CopyC#FaxEnvelope envelope = new FaxEnvelope(); envelope.Recipient.Fax = destinationNumber; envelope.SenderId = icUser; // userId of IC user submitting the fax envelope.TimeSent = DateTime.Now;
Inheritance Hierarchy
System..::..Object
ININ.IceLib.UnifiedMessaging..::..FaxEnvelope
ININ.IceLib.UnifiedMessaging..::..FaxEnvelope
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.
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.
