📄️ Attachments via API
Attachments are passed in to MessageGears using URLs. You can send up to 25 attachments with your messages, with a size limit of 5MB for bulk attachment, and 20MB if it is a transactional attachment. Each attachment has three possible values as specified below. Each field must have a suffix which indicates which attachment number it represents (1 through 5).
📄️ AutoTrack
This feature allows you to automatically make all of the links in you HTML Template trackable. Set the "AutoTrack" parameter to "true" when you submit a Bulk or Transactional job and all of the a href and map href tags will be made trackable using the "Gears.track()" template command (or Gears.trackingTool.getTrackableLink() if you are using Velocity).
📄️ Character Sets
UTF-8 is the default value, and is recommend for almost all situations. However, the character sets below are available as needed.
📄️ Custom Header Values via API
You may add as many as five custom header to your email messages. All headers must begin with "X-" or your API request will be rejected.
📄️ Custom Tracking Domain
When using this feature, always be sure to test it with a few small jobs first. Improper configuration may cause tracking to be disabled, and broken links for your customers.
📄️ OnBehalfOf
This is an advanced feature that is not needed by the vast majority of email senders. For more information, please contact MessageGears Support.
📄️ RecipientListXmlUrl
For bulk jobs, you must pass in the recipient data as a URL pointing to a file which MessageGears retrieve. Currently, the supported protocols are http, https, and Amazon S3. The file may be of any name and may also be plain text or compressed. Passing a file in this way allows for a virtually unlimited number of recipients. We recommend that the file be encoded using the UTF8 (or a compatible subset) character encoding.
📄️ RecipientXML
This field is a user-defined set of XML data that is made accessible to the template for personalization of the message. The following rules apply:
📄️ Referencing Remote Files
| Example URL | Protocol |
📄️ Request ID Type Mapping
A request ID is MessageGears' internal job identifier that is unique across all customers. The code used at the beginning of the request ID indicates the type of job that was triggered. For example, 02-c17306-f12345e6d7f8901eaf2345a67b89012b is of type 'c', or Transactional Campaign.
📄️ SupplementalDataXml
Supplement (formerly called Context) Data is part of an advanced feature specific to bulk jobs. By using this feature, you are able to place any XML data of your choosing into the "context" of the content rendering process. This allows you to access the data inside the template in the same way you access data about the email recipient. Supplemental Data offers even more powerful personalization by giving the template author a place to store and reference data that can be used for cross-selling, weekly specials, and other data that can be presented to each recipient based on attributes associated with that particular recipient.
📄️ UnsubscribeHeader
You can set this value to "true" in your Bulk and Transactional API calls and it will cause a "List-Unsubscribe" header to be added to your email message(s).
📄️ UrlAppend
You must set AutoTrack to true to enable this feature.