2.2.16 FAX_OUTBOX_CONFIG

The FAX_OUTBOX_CONFIG structure defines information about outbox settings of the fax server. This data structure is used as a parameter to the FAX_SetOutboxConfiguration (section 3.1.4.1.87) method.

 typedef struct {
   DWORD dwSizeOfStruct;
   BOOL bAllowPersonalCP;
   BOOL bUseDeviceTSID;
   DWORD dwRetries;
   DWORD dwRetryDelay;
   FAX_TIME dtDiscountStart;
   FAX_TIME dtDiscountEnd;
   DWORD dwAgeLimit;
   BOOL bBranding;
 } FAX_OUTBOX_CONFIG,
  *PFAX_OUTBOX_CONFIG;

dwSizeOfStruct: A DWORD ([MS-DTYP] section 2.2.9) value that holds the total size of the structure, in bytes. This value MUST be 36 bytes.

bAllowPersonalCP: A Boolean that indicates whether fax client applications can include a user-designed cover page template with the fax transmission. If this member is TRUE, the client can provide a personal cover page template. If this member is FALSE, the client MUST use a common cover page stored on the fax server.

bUseDeviceTSID: A Boolean variable that indicates whether the fax server MAY use the devices transmitting subscriber identifier instead of the value specified when submitting a new job. If this member is TRUE, the server SHOULD use the devices transmitting subscriber identifier.

dwRetries: A DWORD that holds the number of times the fax server will attempt to retransmit an outgoing fax if the initial transmission fails.

dwRetryDelay: A DWORD that holds the minimum number of minutes that will elapse between retransmission attempts by the fax server.

dtDiscountStart: A FAX_TIME (section 2.2.61) structure that MUST specify the hour and minute at which the discount period begins. The discount period applies only to outgoing transmissions.

dtDiscountEnd: A FAX_TIME structure that holds the hour and minute at which the discount period ends. The discount period applies only to outgoing transmissions.

dwAgeLimit: A DWORD variable that holds the number of days the fax server will keep unsuccessful fax messages in its outbox queue. If a fax message stays in the outbox queue longer than the value specified, it MAY be automatically deleted. If this value is zero, the time limit MUST NOT be used.

bBranding: A Boolean that indicates whether the fax server generates a brand (banner) at the top of outgoing fax transmissions. If this member is TRUE, the fax server SHOULD generate a brand that contains transmission-related information such as the transmitting subscriber identifier, date, time, and page count.