Cloud Fax and Notifications API 2.4 Documentation
Common Types and Elements
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  Common Elements  
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.
 

3.9.11.1 Default Field Mapping

If no FieldMapping is present in a Table element, the following table shows the mapping that will be applied. Columns with labels not found in the mapping will be added to a segment "CSV", with property keywords corresponding to the column name. (The column labels can also specify a different segment by using the form SEGMENT:KEYWORD.) The effective property keyword (whether determined through FieldMapping/PropertyName or from the column label) should be compatible with internal EasyLink "hdr" format. They may not contain spaces, quotes, or colons. In general, hdr keywords are not excessively long, and consist of ASCII letters, digits, and underscore. A non-compliant name will not necessarily generate an error, but the data may be subsequently inaccessible. (Some provision exists to allow non-compliant names in a Table used for a JobSubmit request specifying MailMergeOptions.)

Field (Column) NameSegmentKeywordDescription
ADDRUSERTODelivery address
TYPEUSERADDR_TYPEAddress type. Legal values are:
faxURLdddtelex
internetlistdedLineother
voicemboxmailgram 
smsx400smQuery 
fodcablegramsoftswitch 
other can only appear in results, as a way of representing invalid, obscure or obsolete address types that may occur (rarely) in old data.
HEADERUSERFAXHDRFax pilot line text.
REFUSERREFCustomer reference. Must be unique within the table.
TOUSERFAXTOReplaces $TO macro on the fax cover page.
FROMUSERFAXFROMReplaces the $FROM macro on the fax cover page.
SUBJECTUSERATTMessage subject for this recipient.
PASSWORDUSERPASSWORDRecipient-specific password for the messageREACH® pull attachments.
EFORMATUSEREFORMATThe email format to use when sending email to this recipient. Currently recognized values are:
text
html
htmllite(for AOL)
ALTADDRALTTOAlternate delivery address.
ALTTYPEALTADDR_TYPEThe type of the alternate delivery address.
INS_NINSERTSINSERT[N]Inserts used for the message customization.
 
    prev  next        Table of Contents  Common Elements  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020