Cloud Fax and Notifications API 2.4 - JobSubmit

Cloud Fax and Notifications API 2.4 Documentation
JobSubmit

Cloud Fax and Notifications API Forums Home

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.7 MailMergeFaxOptions

This may appear inside JobSubmitRequest/Message/JobOptions

Tag Name & type					#	Description
MailMergeFaxOptions MailMergeFaxOptionsType						Implies delivery through XDDS using MailMERGE service. This set of options is similar to FaxOptions but restricted due to the nature of the mailmerge process. Mailmerge data is always provided in the request as a CSV or Excel file.
	Subject EncodableStringType				0-1	A string of up to 65 multibyte characters, providing a way to specify a subject for possible mixed XDDS traffic that may make more sense when no coversheets are applicable. (See EncodableStringType.)
	Pilotline FaxPilotlineOptionType				0-1	Selects 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-1	Indicates the type of pilot line to be used. Legal values are: default none type1 type2 type3 type4 type5 type6 type7 type8
		PilotlineText xs:string			1	Text 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.
	FaxMode FaxModeType				0-1	Indicates the vertical image resolution to be used for fax deliveries. Legal values are: standard fine
	PageOrientation PageOrientationType				0-1	Indicates the page orientation to be used when preparing the document for fax delivery. Legal values are: portrait landscape
	FieldMapping FieldMappingType				0-1	Describes the correspondence between the segment/keyword pairs in the XDDS header file and columns in a destination table which may be represented by CSV or XLS file. If no field mapping specified, the default one (described below) is assumed.
		Map			1-	This element maps one column label to a specific address keyword. There should be one Map element for each mapped column. Columns with labels not found in the mapping will be added to a segment "CSV", with keywords corresponding to the column name.
			FieldName xs:string		1	The column label or name in the table data that is to be mapped to an address property
			SegmentName xs:string		0-1	The segment of the address information (header) that will contain the property being mapped to. If not specified, the default "USER" segment will be used.
			PropertyName xs:string		1	The property (keyword) name of the address that will contain the values found in this column.
			IsBase64Encoded xs:boolean		0-1	Boolean Value. Defines the way data will be handled in the system. The corresponding column should contain base64-encoded data.
	DeliveryRetryPattern xs:string				0-1	The 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.
	MailMergeFaxJobExtensions JobExtensionsType				0-1	This element may be used to permit access to job options not otherwise accessible through the Cloud Fax and Notifications API schema. No such extensions are currently available.
		Segment SegmentType			1-	Extensions may be divided into categories, and the segment will indicate the category.
			@name xs:string		0-1	The name of the segment. No name will indicate the default ("USER") segment.
			Property		1-	This element will contain the specific extension value
				@name xs:string	1	The name of the extension. None are currently defined.
				@b64charset xs:string	0-1	The value may be base64 encoded to convey data in a particular character set. Ssee EncodableStringType.

For a Message containing MailMergeFaxOptions, if no FieldMapping is explicitly indicated, the following table shows the default mapping that will be applied:

Field (Column) name	Segment	Keyword	Description
ADDR	USER	TO	Delivery address
TYPE	USER	ADDR_TYPE	Address type. The only value supported for the mailMERGE fax message is .fax.. This field may be omitted.
HEADER	USER	FAXHDR	Fax pilot line text.
REF	USER	REF	Customer reference. Must be unique within the table.
TO	USER	FAXTO	Replaces $TO macro on the fax cover page.
FROM	USER	FAXFROM	Replaces the $FROM macro on the fax cover page.
SUBJECT	USER	ATT	Message subject for this recipient.
ALTADDR	ALT	TO	Alternate delivery address.
ALTTYPE	ALT	ADDR_TYPE	The type of the alternate delivery address.
INS_N	INSERTS	INSERT[N]	Inserts used for the message customization.

Destination information is repackaged as a CSV file prior to the mailmerge processing. To avoid processing errors, a complete FieldMapping - covering all fields found in the destination data - should be provided if the default mapping does not cover it.

prev next Table of Contents JobSubmit

This information is subject to change. Please check frequently for updates.
Modified October 06, 2020