Cloud Fax and Notifications API 2.5 Documentation
JobSubmit
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobSubmit  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

31.2.3 FaxOptions

This may appear inside JobSubmitRequest/Message/JobOptions

Tag Name
& type
#Description
FaxOptions
FaxOptionsType
   This contains options relevant to fax deliveries, currently implying the use of XDDS. This tag may be empty, but still must be present to indicate fax delivery.
   FaxCoversheet
FaxCoversheetOptionType
0-1This contains information pertaining to the presence and contents of a fax coversheet. If FaxCoversheet element is absent, the coversheet behavior will be controlled by the user profile settings.
   UseCoversheet
YesNo
1This contains either "yes" or "no" indicating whether or not a coversheet should be used. This element does not have to be accompanied by the coversheet name, in which case the default coversheet will be used.
   CoversheetName0-1This contains the name (maximum length 15 characters) of the coversheet template to be used. If not specified and UseCoversheet is "yes", the user's default coversheet will be used.
Currently, only custom coversheets specifically assigned to the requesting user are accessible using this field.
   CoversheetTo
EncodableStringType
0-1Value for the $TO coversheet macro for all items which do not define this parameter. If no coversheet is requested for a job, this element is ignored. Only 8 lines of 65 multibyte characters allowed. See EncodableStringType.
   CoversheetFrom
EncodableStringType
0-1Value for the $FROM coversheet macro for all items which do not define this parameter. If no coversheet is requested for a job, this element is ignored. Only 8 lines of 65 multibyte characters allowed. See EncodableStringType.
   CoversheetAttn
EncodableStringType
0-1Value for the $ATTN coversheet macro for all items which do not define this parameter. If no coversheet is requested for a job, this element is ignored. Only 8 lines of 65 multibyte characters allowed. See EncodableStringType.
   Subject
EncodableStringType
0-1A string of up to 65 multibyte characters, providing an alternate way to specify a subject for possible mixed XDDS traffic that may make more sense when no coversheets are applicable. It will be ignored if a value for FaxOptions/FaxCoversheet/CoversheetAttn is also specified. See EncodableStringType.
   Pilotline
FaxPilotlineOptionType
0-1Selects the style and content of the line on the very top of the fax page (sometimes call the fax banner - not to be confused with bannerfx). Pilot line styles are described in the EasyLink API Forum here.
   PilotlineStyle
PilotlineStyleType
0-1Indicates the type of pilot line to be used. Legal values are:
  • default
  • none
  • type1
  • type2
  • type3
  • type4
  • type5
  • type6
  • type7
  • type8
   PilotlineText
xs:string
1Text to be used, if applicable, in the pilot line in the format indicated by PilotlineStyle element. The maximum size of this element content is 23 ASCII characters. If it exceeds 23 characters, the line will be silently truncated.
   BannerFX
FaxBannerFxOptionType
0-1Used to access the BannerFX features of XDDS.
   UseBannerFx
YesNo
0-1"yes" requests BannerFx features.
   BannerFxName
xs:string
0-1Name of an existing BannerFx object.
   BannerFxPlacement
FaxBannerFxPlacementType
0-1Controls the placement of the BannerFx image on the fax page. The valid choices are:
outsideimage placed outside of the page
inside_replaceimage placed inside the page, replacing the main content
insideorimage placed inside the page and merged with the main content
   BannerFxOnCover
YesNo
0-1May take the value of "yes" or "no". Indicates whether the banner should be placed on the cover page or the first page of the document. Use of this element only makes sense for PCL covers. Regular FDC-generated cover pages are not affected. If the value is .yes. then FDC will consider all the cover pages a part of the document for the BannerFx rasterization.
   FaxMode
FaxModeType
0-1Indicates the vertical image resolution to be used for fax deliveries. Legal values are:
  • standard
  • fine
   Letterhead
xs:string
0-1The name of a previously stored letterhead to be used. The special values "NO" and "NONE" may also be supplied to indicate no letterhead.
   PageOrientation
PageOrientationType
0-1Indicates the page orientation to be used when preparing the document for fax delivery. Legal values are:
  • portrait
  • landscape
   DeliveryRetryPattern
xs:string
0-1The name of the retry pattern to be used for the job. These names are determined by switch configuration, and the names and patterns may be different for different optionsets.
   FaxJobExtensions
JobExtensionsType
0-1This element may be used to permit access to job options not otherwise accessible through the Cloud Fax and Notifications API schema.
   Segment
SegmentType
1-Extensions may be divided into categories, and the segment will indicate the category.
   @name
xs:string
0-1The name of the segment. No name will indicate the default (USER) segment.
   Property1-This element will contain the specific extension value
   @name
xs:string
1The name of the extension. The following are defined:
SegmentPropertyDescription
USERFAXHDRThe same functionality as PilotlineText, except this allows the use of an EncodableStringType for non-UTF8 values.
USERcharsetUsed for specialized Mail2Fax jobs. May be "utf-8 or "UTF-8".
   @b64charset
xs:string
0-1The value may be base64 encoded to convey data in a particular character set. Ssee EncodableStringType.
 
    prev  next        Table of Contents  JobSubmit  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified OOctober 06, 2020