Reference Guide

Contents

Reference Guide#

Important

Presort Object is deprecated. Please check our latest Release Note for more information.

Introduction#

Use Presort Object to automate your mailings and maximize postal discounts. If you have mailings of 500 or more pieces for First Class, or 200 pieces for Standard Class, presorting the records before mailing them out eliminates the need for the USPS to do so. The savings in labor and resources are passed on to you, the mailer, in the form of lower postage rates. A Mailing permit must be previously authorized with the USPS for you to receive bulk mail discounts. Also please note that bulk mail discounts hinge on validating addresses with a CASS™ certified engine such as Address Object and regularly performing National Change of Address NCOALink™ on your mailing lists.

Presort Object takes care of the front end of the process of presorting. It will take your mailing list and sort it according to class, weight, size and quantity, based on the ZIP and ZIP + 4, to create a presorted mailing for maximum savings. When the requested information is entered, Presort Object will consider which pieces qualify and sort the list accordingly. Presort Object also provides PDF images of all the necessary reports such as the Qualification Report, Postage Statement, and Tray Tags.

Use Presort for the following sortations:

FIRST CLASS MAIL

  • PostCards

  • Letters

  • Flats

  • Non-Machinable

  • EMM Trays

STANDARD CLASS MAIL

  • Letters

  • Profit

  • Non-Profit

  • Non-Machinable

  • Flats

  • Enhanced Carrier Route

  • Destinations SCF/BMC

Setup and List of Files#

To see how to set up the Presort Object, the list of files that will be downloaded and used, and the system requirements to run the Object, please visit the GitHub Sample Code.

Methods#

Setup Methods - Set#

InitializeDataFiles#

Syntax:

InitializeDataFiles();

Returns:

Initialize Status

Return Type:

ProgramStatus

Required.

Connects the current instance of Presort Object to its data files in preparation for a new presort operation.

This must be called before any other operations can be performed. Setting properties or calling another method without first calling this method will generate an error.

You must set the SetPathToPresortDataFiles property with a valid path and call the SetLicenseString method before calling this method.

Return: Enumerated Value.

Returns a non-zero enumerated value of the type ProgramStatus.

If Presort Object initialization is successful, this method will return zero. If initialization is not successful, call the GetInitializeErrorString method to determine the cause. Any other result indicates that the object did not initialize successfully

SetLicenseString#

Syntax:

SetLicenseString(String License);

Returns:

Is License Valid

Return Type:

Boolean

Required.

Input: String Value.

Sets the license string which enables the use of Presort Object.

Without the license string, the object will not function.

This property must be set before calling the InitializeDataFiles method.

You may also use environment variables to set the license string. For information on how to do this, please refer to: http://www.melissadata.com/tech/address-object-faq/using-address-object/index.asp?CATE=0#1

Return: Boolean Value.

If a True value is returned, the license string was valid.

If a False value is returned, the license string was invalid.

SetPathToPresortDataFiles#

Syntax:

SetPathToPresortDataFiles(String Path);

Return Type:

Void

Required.

Input: String Value.

Sets the path to the directory containing the data files used by Presort Object. This must contain a valid path to the directory containing the Presort Object data files.

The data files are as follows:

3600r_t.pdf        mdL004A.dat         mdL201A.dat
3602n_T.pdf        mdL004B.dat         mdL201B.dat
3602r_T.pdf        mdL004C.dat         mdL601.dat
mdCityState.dat    mdL005.dat          mdL602.dat
mdDropship.dat     mdL007.dat          mdL801A.dat
mdDSF.dat          mdL008.dat          mdL801B.dat
mdL001.dat         mdL009A.dat         mdPresort.lic
mdL002A.dat        mdL009B.dat         mdScheme5.dat
mdL002B1.dat       mdL010.dat          mdValid5.dat
mdL002B2.dat       mdL011A.dat         PostalRatesFiles.txt
mdL002C.dat        mdL011B.dat

This property must be set before calling the InitializeDataFiles method.

Setup Methods - Get#

GetBuildNumber#

Syntax:

GetBuildNumber();

Returns:

Build Number

Return Type:

String

Optional.

Input: String Value.

Returns the build number of the currently installed Presort Object.

Have this number available when contacting Melissa Data for technical support.

GetDatabaseDate#

Syntax:

GetDatabaseDate();

Returns:

Database Date

Return Type:

DateValue

Optional.

Input: Date Value.

Returns the date of the current database.

If this method is called before InitializeDataFiles, an exception will occur.

GetDatabaseExpirationDate#

Syntax:

GetDatabaseExpirationDate();

Returns:

Database Expiration Date

Return Type:

DateValue

Optional.

Input: Date Value.

Returns the date when your current data files will expire.

This allows you to confirm that the data files that you are using are the latest ones. If this method is called before InitializeDataFiles, an exception will occur.

GetInitializeErrorString#

Syntax:

GetInitializeErrorString();

Returns:

Initialize Error Description

Return Type:

String

Optional.

Return: String Value.

Returns a description of the error generated by an unsuccessful call to InitializeDataFiles.

Call this method if InitializeDataFiles fails to initialize Presort Object.

GetLicenseStringExpirationDate#

Syntax:

GetLicenseStringExpirationDate();

Returns:

License String Expiration Date

Return Type:

DateValue

Optional.

Input: Date Value.

Returns the date when your current license string will expire and Presort Object will no longer function.

To use Presort Object after this date, you will need to contact Melissa Data’s sales department at 1-800-MELISSA and purchase an extension to your subscription.

GetParametersErrorString#

Syntax:

GetParametersErrorString();

Returns:

Parameters Error Description

Return Type:

String

Optional.

Return: String Value.

Returns a description of any error generated by calls to UpdateParameters, AddRecord, or DoPresort.

If any of these return a false value when called, use this method to return a string value describing the cause for the first error encountered.

Input Methods: Sort Settings#

SetBusinessResidentialIndicator#

Syntax:

SetBusinessResidentialIndicator(String Indicator);

Return Type:

Void

Optional.

Input: String Value.

Indicates whether the current record is a business or residential address. It accepts either a “B” for business address or “R” for a residential address.

SetBusinessResidentialIndicator is required to receive Saturation and High Density discounts.

SetCarrierRoute#

Syntax:

SetCarrierRoute(String CarrierRoute);

Return Type:

Void

Optional.

Input: String Value.

Sets the Carrier Route number for the next record to be added to the sort.

SetCarrierRoute is required to presort for carrier route postage, Saturation, High Density, and eLOT® discounts.

SetContinueContainerNumber#

Syntax:

SetContinueContainerNumber(Boolean IsContinuous);

Return Type:

Void

Optional.

Input: Boolean Value.

Enables continuous numbering of containers between sortation levels.

If set to True, the numbering of containers on reports will be contiguous through all containers, regardless of sortation levels.

If set to False, numbering on the reports will restart between sortation levels.

For example, if a list includes 50 Automation and 40 Nonautomation containers, and this method is set to false, then the numbering of the Automation containers will be 1 through 50 and the Nonautomation containers will be numbered 1 through 40. If this method were set to True, then the Non-Automation containers will be number 51 through 90.

SetDeliveryPointCode#

Syntax:

SetDeliveryPointCode(String DeliveryPointCode);

Return Type:

Void

Optional.

Input: String Value.

Sets the Delivery Point Code for the current record.

The Delivery Point Code is a two digit value used to generate the Delivery Point Barcode number for each address. For street addresses it is usually the last two digits of the street number.

If you have the full twelve-digit delivery point barcode number, the Delivery Point Code is found at digits eleven and twelve.

SetDeliveryPointCode is required for Automation, Saturation, High Density, and eLot discounts.

SetIMBSerialNumber#

Syntax:

SetIMBSerialNumber(String IMBSerialNumber);

Return Type:

Void

Optional.

Input: All Digits String Value.

Sets the Intelligent Mail barcode number.

This allows you to assign a distinct number for each mail piece in the IMB.

For more information see “Intelligent Mail barcode” on page 108.

SetLOTNumber#

Syntax:

SetLOTNumber(String LOTNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the Line-Of-Travel number required for any Standard Mail® LOT sortation.

The Line-of-Travel number designates approximately where the submitted address falls within the ZIP + 4®.

SetLOTNumber is required if the sortation selected using SetPresortSettings contains the designation “LOT.”

SetLOTOrder#

Syntax:

SetLOTOrder(String LOTOrder);

Return Type:

Void

Optional.

Input: String Value.

Sets the indicator for ascending or descending Line-of-Travel order. Set to “A” for ascending order (lowest to highest LOT Number) and “D” for descending (highest to lowest LOT Number.)

The Line-of-Travel Order designates whether the Post Office delivers mail in the current ZIP + 4 in ascending or descending order according to the LOT Number.

SetLOTOrder is required if the sortation selected using SetPresortSettings contains the designation “LOT.”

SetMailersID#

Syntax:

SetMailersID(String MailersID);

Return Type:

Void

Required.

Input: String Value. Six or nine numeric characters.

Sets the Mailer ID issued by the USPS®. This number is used by the Intelligent Mail® barcode system and is different from the mail permit number.

You can apply for a Mailer ID by visiting USPS.COM® and clicking on the Business Customer Gateway link at the bottom of the page.

SetPlus4#

Syntax:

SetPlus4(String Plus4);

Return Type:

Void

Optional.

Input: String Value.

Sets the 4-digit ZIP Code add-on for the current record. If the ZIP + 4 for the address is 92688-2112, then the Plus4 would be 2112.

SetPlus4 is required in order to receive the Automation discount. You must use a CASS certified product like Melissa Data’s Address Object to append Plus4 codes to your database.

SetPSPresortResidualPieces#

Syntax:

SetPSPresortResidualPieces(String PSPresortResidualPieces);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is True.

If set to True, this will include residual mail pieces (mail pieces that do not qualify for any sortation discounts) on the Postage Statement. For First-Class, the residual report will be included on the First-Class Postage Statement. For Standard, the residual report will be on a second First-Class Postage Statement.

If set to False, this will exclude the residual mail pieces.

SetRecordID#

Syntax:

SetRecordID(String RecordID);

Return Type:

Void

Optional.

Input: String Value.

Sets a unique identifier that aids in linking each record in the presorted list back to a single address record in the original database.

After a successful call to the DoPresort method, you can pass value to the GetRecord method to retrieve records. It is also returned by the GetRecordID method when you call the GetFirstRecord and GetNextRecord methods, enabling you to match the records in the presorted list to the original database.

SetSackWeight#

Syntax:

SetSackWeight(String SackWeight);

Return Type:

Void

Optional.

Input: Single Precision Value.

Sets the maximum weight of a single sack of Standard Flats to either 30 or 70 pounds.

Sacks for presorted Standard flats come in either 30 or 70 pound sizes. 70 pound sacks are used by default. Set the value to 30 to change to the smaller sack size.

SetWalkSequence#

Syntax:

SetWalkSequence(String WalkSequence);

Return Type:

Void

Optional.

Input: String Value.

Sets the walk sequence number for the current record.

The Walk Sequence number represents the exact order of delivery for addresses within a given carrier route. Each address within the carrier route will have a unique Walk Sequence number.

Sorting according to the Walk Sequence number puts the mail pieces in the exact order of delivery, so Walk Sequence sortations will have the lowest postage rates.

Walk Sequence numbers are not returned by CASS Certified address verification tool such as Melissa Data’s Address Object. A Walk Sequence number must be included in a list when purchased or appended by a USPS-certified vendor.

SetWalkSequence is required for Saturation and High Density discounts.

SetZip#

Syntax:

SetZip(String ZIP);

Return Type:

Void

Required.

Input: String Value.

Sets the 5-digit ZIP Code for the current record.

A 5-digit ZIP Code is necessary to successfully include a record in a presort, so this property must be set before calling the AddRecord method.

Input Methods: Setting Piece Dimensions#

After setting or updating the following properties, you must call the UpdateParameters method before calling either the AddRecord or DoPresort methods.

SetPieceHeight#

Syntax:

SetPieceHeight(String PieceHeight);

Return Type:

Void

Required.

Input: Single Precision Value as String.

Sets the dimension, in inches, of the edge of the mail piece perpendicular to the address as read.

  • For letters the height must be between 3.5 and 6.125 inches.

  • For cards, the height must be between 3.5 and 4.25 inches. (First-Class Only)

  • For flats, the height must be between 5 and 12 inches.

SetPieceLength#

Syntax:

SetPieceLength(String PieceLength);

Return Type:

Void

Required.

Input: Single Precision Value as String.

Sets the dimension, in inches, of the edge of the mail piece parallel to the address as read.

  • For letters the length must be between 5 and 11.5 inches.

  • For cards, the length must be between 5 and 6 inches. (First-Class Only)

  • For flats the length must be between 6 and 15 inches.

SetPieceThickness#

Syntax:

SetPieceThickness(String PieceThickness);

Return Type:

Void

Required.

Input: Single Precision Value.

Sets the thickness, in inches, of the single mail piece from the current mailing.

To follow the USPS method of calculating the thickness, place 10 to 20 mail pieces in a container and tilt the container at 45 degrees. After the pieces have compressed naturally, you can measure the thickness of the stack and calculate the average thickness of each piece.

  • For letters, the thickness can be between 0.007 and 0.25 inches.

  • For cards, the thickness can be between 0.007 and 0.016 inches. (First-Class Only)

  • For flats, the thickness must be between 0.007 and 0.75 inches.

SetPieceWeight#

Syntax:

SetPieceWeight(String PieceWeight);

Return Type:

Void

Required.

Input: Single Precision Value.

Sets the weight, in ounces, of a single mail piece.

  • The maximum weight for letters and cards is 3.5 ounces.

  • The maximum weight for flats is 13 ounces for First-Class Mail® and 16 ounces for Standard Mail.

Postage Statement Methods: Permit Holder Contact Information#

The following properties are used to enter the contact information for the permit holder for the current mailing. This information will appear on the Qualification Report and Postage Statement.

SetPSCAPSNumber#

Syntax:

SetPSCAPSNumber(String CAPSNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the Centralized Account Process System (CAPS) number to be printed on the Postage Statement, if any.

CAPS is an electronic postage payment system that provides business mailers a centralized, convenient, and cost-effective way pay for postage. It provides an electronic alternative to presenting checks and cash for postage and fees at multiple post offices.

SetPSCustomerNumber#

Syntax:

SetPSCustomerNumber(String CustomerNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets any customer number to be printed on the Postage Statement. If the mailing is being handled by a mailing house for a client, that client’s customer number, if any, can be entered here.

SetPSNonProfitAuthNumber#

Syntax:

SetPSNonProfitAuthNumber(String NonProfitAuthNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the authorization number needed to claim non-profit status.

The Non-Profit Authorization Number is printed on the Postage Statement. This alerts the Post Office that you are allowed to claim Non-Profit rates.

SetPSPermitHolderCity#

Syntax:

SetPSPermitHolderCity(String PermitHolderCity);

Return Type:

Void

Required.

Input: String Value.

Sets the city from the permit holder’s address.

SetPSPermitHolderCompany#

Syntax:

SetPSPermitHolderCompany(String PermitHolderCompany);

Return Type:

Void

Optional.

Input: String Value.

Sets the permit holder’s company name, if any.

SetPSPermitHolderEmail#

Syntax:

SetPSPermitHolderEmail(String PermitHolderEmail);

Return Type:

Void

Required.

Input: String Value.

Sets the permit holder’s email address.

SetPSPermitHolderListName#

Syntax:

SetPSPermitHolderListName(String PermitHolderListName);

Return Type:

Void

Required.

Input: String Value.

Sets the name of the database containing the list being presorted.

SetPSPermitHolderName#

Syntax:

SetPSPermitHolderName(String PermitHolderName);

Return Type:

Void

Required.

Input: String Value.

Sets the permit holder’s contact name.

SetPSPermitHolderPhone#

Syntax:

SetPSPermitHolderPhone(String PermitHolderPhone);

Return Type:

Void

Required.

Input: String Value.

Sets the permit holder’s phone number.

SetPSPermitHolderState#

Syntax:

SetPSPermitHolderState(String PermitHolderState);

Return Type:

Void

Required.

Input: String Value.

Sets the State from the permit holder’s address.

SetPSPermitHolderStreet#

Syntax:

SetPSPermitHolderStreet(String PermitHolderStreet);

Return Type:

Void

Required.

Input: String Value.

Sets the permit holder’s street address.

SetPSPermitHolderZIP#

Syntax:

SetPSPermitHolderZIP(String PermitHolderZIP);

Return Type:

Void

Required.

Input: String Value.

Sets the permit holder’s ZIP Code™.

Postage Statement Methods: Mailing Agent Information#

The following properties are used to enter the contact information of the mailing agent for the current mailing, if a mailing agent was used.

The mailing agent’s contact information appears on the postage statement created by Presort Object.

SetPSMailingAgentCity#

Syntax:

SetPSMailingAgentCity(String MailingAgentCity);

Return Type:

Void

Optional.

Input: String Value.

Sets the city from the mailing agent’s address.

SetPSMailingAgentCompany#

Syntax:

SetPSMailingAgentCompany(String MailingAgentCompany);

Return Type:

Void

Optional.

Input: String Value.

Sets the mailing agent’s company name, if any.

SetPSMailingAgentCRID#

Syntax:

SetPSMailingAgentCRID(String MailingAgentCRID);

Return Type:

Void

Optional.

Input: String Value.

Sets the CRID of the mailing agent. This is the USPS ID.

SetPSMailingAgentName#

Syntax:

SetPSMailingAgentName(String MailingAgentName);

Return Type:

Void

Optional.

Input: String Value.

Sets the mailing agent’s contact name.

SetPSMailingAgentPhone#

Syntax:

SetPSMailingAgentPhone(String MailingAgentPhone);

Return Type:

Void

Optional.

Input: String Value.

Sets the mailing agent’s phone number.

SetPSMailingAgentState#

Syntax:

SetPSMailingAgentState(String MailingAgentState);

Return Type:

Void

Optional.

Input: String Value.

Sets the State from the mailing agent’s address.

SetPSMailingAgentStreet#

Syntax:

SetPSMailingAgentStreet(String MailingAgentStreet);

Return Type:

Void

Optional.

Input: String Value.

Sets the mailing agent’s street address.

SetPSMailingAgentZIP#

Syntax:

SetPSMailingAgentZIP(String MailingAgentZip);

Return Type:

Void

Optional.

Input: String Value.

Sets the mailing agent’s ZIP Code.

Postage Statement Methods: Individual or Organization Information#

The following properties set the name for the individual or organization for whom the current mailing is being prepared, if any. This information will appear on the Postage Statement created by Presort Object.

SetPSIndividualOrOrganizationCity#

Syntax:

SetPSIndividualOrOrganizationCity(String IndividualOrOrganizationCity);

Return Type:

Void

Optional.

Input: String Value.

Sets the city from the party’s address.

SetPSIndividualOrOrganizationCompany#

Syntax:

SetPSIndividualOrOrganizationName(String IndividualOrOrganizationCompany);

Return Type:

Void

Optional.

Input: String Value.

Sets the individual or organization’s company name, if any.

SetPSIndividualOrOrganizationCRID#

Syntax:

SetPSIndividualOrOrganizationCRID(String IndividualOrOrganizationCRID);

Return Type:

Void

Optional.

Input: String Value.

Sets the CRID of the individual or organization. This is the USPS ID.

SetPSIndividualOrOrganizationName#

Syntax:

SetPSIndividualOrOrganizationName(String IndividualOrOrganizationName);

Return Type:

Void

Optional.

Input: String Value.

Sets the individual or organization’s name.

SetPSIndividualOrOrganizationStreet#

Syntax:

SetPSIndividualOrOrganizationName(String IndividualOrOrganizationStreet);

Return Type:

Void

Optional.

Input: String Value.

Sets the individual or organization’s street address.

SetPSIndividualOrOrganizationState#

Syntax:

SetPSIndividualOrOrganizationState(String IndividualOrOrganizationState);

Return Type:

Void

Optional.

Input: String Value.

Sets the State from the individual or organization’s address.

SetPSIndividualOrOrganizationZIP#

Syntax:

SetPSIndividualOrOrganizationZIP(String IndividualOrOrganizationZip);

Return Type:

Void

Optional.

Input: String Value.

Sets the individual or organization’s ZIP Code.

Postage Statement Methods: Post Office of Mailing Information#

The post office of mailing is the USPS branch that granted the mailing permit being used for the current mailing. It is required to determine the mailing’s qualification for automation discounts.

Without this information, you will get an error when you call the DoPresort method.

This information appears on all reports and the Postage Statement.

SetPSPostOfficeOfMailingCity#

Syntax:

SetPSPostOfficeOfMailingCity(String PostOfficeOfMailingCity);

Return Type:

Void

Required.

Input: String Value.

Sets the city for the post office of mailing.

SetPSPostOfficeOfMailingState#

Syntax:

SetPSPostOfficeOfMailingState(String PostOfficeOfMailingState);

Return Type:

Void

Required.

Input: String Value.

Sets the State for the post office of mailing.

SetPSPostOfficeOfMailingZIP#

Syntax:

SetPSPostOfficeOfMailingZIP(String PostOfficeOfMailingZIP);

Return Type:

Void

Required.

Input: String Value.

Sets the ZIP Code for the post office of mailing.

Postage Statement Methods: Postage Type#

Postage type defaults to metered when SetPSPermitImprint and SetPSPrecanceledStamp are either not called or set to False.

SetPSPermitImprint#

Syntax:

SetPSPermitImprint(Boolean PermitImprint);

Return Type:

Void

Optional.

Input: Boolean Value. Default value is False.

If set to True, the current mailing will use a permit imprint as the method of postage payment.

If set to False, Presort Object will use metered mail as the payment method. This information will be indicated on your Postage Statement.

SetPSPrecanceledStamp#

Syntax:

SetPSPrecanceledStamp(Boolean PrecanceledStamp);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

The payment method preference will be indicated on your postage statement.

If set to True, indicates that the current mailing will use a precanceled stamps as the postage payment method and SetPSPrecanceledStampValue must be set.

If set to False, Presort Object will use metered mail as the postage payment method.

SetPSPrecanceledStampValue#

Syntax:

SetPSPrecanceledStampValue(String PrecanceledStampValue);

Returns:

Successful

Return Type:

Boolean

Optional.

Input: Single Precision Value.

Sets the postage value in cents of a precanceled stamp used for the current mailing. (Ex: 0.45)

This must be called if the SetPSPrecanceledStamp property is set to True.

Return: Boolean Value.

If a True value is returned, the method was called correctly.

If a False value is returned, an error occurred. A value of zero or less was inputted. Call GetParametersErrorString to determine the cause.

Postage Statement Methods: Mailing Parameters#

SetPermitNumber#

Syntax:

SetPermitNumber(String PermitNumber);

Return Type:

Void

Required.

Input: String Value.

Sets a unique number used to identify the mailer to the USPS. This information is included on the Postage Statement and Qualification Report.

The mailing permit number is separate from the Mailer ID used for the Intelligent Mail barcode system. This would normally be the bulk permit number assigned by the USPS when you turned in form 3615 at the local Post Office.

For information on applying for a Bulk Mail Permit, visit USPS.COM and click on Business. Follow the links for payment options, under the link about Postage meters.

SetPSCASSDate#

Syntax:

SetPSCASSDate(String PSCASSDate);

Return Type:

Void

Required.

Input: String Value.

Sets the date when the current list was subjected to address verification. This date is supplied by the customer and follows the “MMDDYYYY” format. Ex: 06272012.

To ensure the accuracy of move information, the Postage Statement must list the date when the mailing list was processed with a CASS Certified™ address verification software.

SetPSFedAgencyCode#

Syntax:

SetPSFedAgencyCode(String FederalAgencyCode);

Return Type:

Void

Optional.

Input: String Value.

Sets the Federal agency code to be printed on the Postage Statement, if any.

Federal agencies would use this property to record a special agency number. If you are not a federal agency, do not use this property.

SetPSMailingDate#

Syntax:

SetPSMailingDate(String MailingDate);

Return Type:

Void

Required.

Input: String Value.

Sets the mailing date to be printed on the Postage Statement. This should reflect the date that the mail pieces are deposited with the Post Office.

SetPSOfficialElectionMail#

Syntax:

SetPSOfficialElectionMail(String OfficialElectionMail);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to true, this indicates the current mailing as Official Election Mail.

Official Election Mail is any mailpiece created by an authorized election official that is mailed to or from a citizen of the United States for the purpose of participating in the voting process including:

  • Vote-by-Mail ballots.

  • Sample ballot materials.

  • Voter registration cards.

  • Absentee applications.

  • Polling place notifications.

This will also attach the official election mail logo for easier visibility for the post office and voters. This logo should be used on any mailpiece created by an election official that is mailed to or from a citizen of the United States for the purpose of participating in the voting process.

The purpose of Official Election Mail is to designate the mail as important and distinct from partisan political mailings. This is not intended to upgrade the service or as a substitute for postage.

SetPSPoliticalCampaignMailing#

Syntax:

SetPSPoliticalCampaignMailing(String PSCASSDate);

Returns:

Is Political

Return Type:

Boolean

Optional.

Input: Boolean Value. Default setting is False.

If set to true, this indicates the current mailing as Political Campaign Mail.

Political Campaign Mail is any piece mailed for political campaign purposes by a registered political candidate, a campaign committee, or a committee of a political party to promote political candidates, referendums, or political campaigns.

This will also attach a red tag to the tray for visibility.

SetPSStatementSeqNumber#

Syntax:

SetPSStatementSeqNumber(String StatementSeqNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the postage statement sequence number to be printed on the Postage Statement.

Some mailings need to use more than one Postage Statement. When this happens, the postage statements will have sequence numbers (1 of 4, 2 of 4, etc.). Pass that number to this method.

You do not need to call this method if you are using a single Postage Statement.

Postage Statement Methods: Move Update Method#

Use these methods to designate the method used to update move (change-of-address) information for the list used in the current mailing. One and only one of the following methods should called and set to True. This information will be reflected on the Postage Statement.

SetPSACS#

Syntax:

SetPSACS(Boolean UseACS);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses Address Change Service (ACS™) for move updates.

In ACS, mailers modify their mailing label format to include a mailer identification (participant) code assigned by the National Customer Support Center (NCSC).

SetPSAltAddFmt#

Syntax:

SetPSAltAddFmt(Boolean UseAltAddressFormat);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses an Alternative Address Format.

SetPSAltMethod#

Syntax:

SetPSAltMethod(Boolean UseAltMethods);

Return Type:

Void

First-Class Mail Only.

Input: Boolean Value.

If set to True, this mailing uses one of two alternate update methods.

In addition to the four USPS-approved move update methods described above, there are two alternative methods. These are only available for First-Class Mail.

SetPSASE#

Syntax:

SetPSASE(Boolean UseASE);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses Ancillary Service Endorsements (ASE) for move updates.

Ancillary Service Endorsements (ASE’s) assist in the delivery of your mail or the update of your mailing list. Undeliverable-as-addressed mail is forwarded, returned to the sender, or treated as dead mail as authorized by that particular mail class.

SetPSFASTForward#

Syntax:

SetPSFASTForward(Boolean UseFastForward);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses FASTforward® for move updates.

FASTforward prints the new address on the mail piece just before it enters the mail-stream.

SetPSMultiple#

Syntax:

SetPSMultiple(Boolean UseMultipleMethods);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses two or more update methods.

Use this setting when more than one move update method was used on the current list.

SetPSNCOA#

Syntax:

SetPSNCOA(Boolean UseNCOA);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses NCOALink® for move updates.

Use this setting if you have used an NCOALink update service such as Melissa Data’s Smart Mover Web Service, NCOALink update service, or Smart Mover Real-time Update.

SetPSOneCode#

Syntax:

SetPSOneCode(Boolean UseOneCodeACS);

Return Type:

Void

Input: Boolean Value.

If set to True, this mailing uses OneCode ACS® for move updates.

OneCode ACS lets mailers use the barcode to access the agency’s electronic Address Change Service (ACS) to obtain move information in the event that someone relocates after a mail piece has entered the mail-stream.

Tray Tag Properties#

The following properties are used to set up tray tags.

SetTTBorder#

Syntax:

SetTTBorder(Boolean UseTTBorder);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to True, enables the printing of a border around each container tag.

If set to False, this is disabled.

This is useful if you print tray tags on standard paper instead of perforated forms, to assist in cutting the tags to the proper size.

SetTTContainerNumber#

Syntax:

SetTTContainerNumber(Boolean WillPrintContainerNumber);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to True, enables the printing of the serialized number for each container on the first line of each container tag.

If set to False, this is disabled.

Numbering of containers can be continuous for an entire mailing or it can be restarted for each sortation type. For more information, see SetContinueContainerNumber.

SetTTContainerSize#

Syntax:

SetTTContainerSize(Boolean WillPrintContainerSize);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

For letters only. This sets the printing of the container size (1’ or 2’) on the first line of each container tag.

If set to True, this will append the container size on the container tags.

If set to False, it will not.

Printed

Container Type

Sack

Sack (Flats)

1’

1-foot Tray (Letters)

2’

2-foot Tray (Letters)

EMM

Large tub for outsized mail pieces

SetTTNumberOfPieces#

Syntax:

SetTTNumberOfPieces(Boolean WillPrintNumberOfPieces);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to True, enables the printing of the number of mail-pieces in each container on the first line of each container tag.

If set to False, this is disabled.

Printing the number of mail-pieces on the tray tag is a convenient way to verify your counts when assembling the mailing.

SetTTOther#

Syntax:

SetTTOther(String AdditionalTextToPrint);

Return Type:

Void

Optional.

Input: String Value.

Sets the contents of additional text that will be printed on the first line of the container tag. This can include any additional information the mailer feels is necessary to identify the contents of the containers in this mailing.

SetTTParameterPositionX#

Syntax:

SetTTParameterPositionX(String ParameterPositionX);

Return Type:

Void

Optional.

Input: String Value.

Sets the distance, in points, between the expected left margin and the actual left margin. Enter a positive number to print further to the right or a negative number to print further to left. Decimal values may be used in a string format. Ex: “4.5”

Not all printers are the same and these differences can lead to misalignment when printing container tags on perforated forms. Points, the unit of measure for this property, are a standard unit of measure for printing. Refer to this chart to convert inches to points, if necessary:

1/8" = 9 points

1/6" = 12 points

1/4" = 18 points

1/2" = 36 points

1" = 72 points

It may be necessary to print a sample run of container tags, and then measure the differences between what is printed and the actual dimensions of the form.

SetTTParameterPositionY#

Syntax:

SetTTParameterPositionY(String ParameterPositionY);

Return Type:

Void

Optional.

Input: String Value.

Sets the distance, in points, between the expected top margin and the actual top margin. Enter a positive number to print lower or a negative number to print closer to the top of the page. Decimal values may be used in a string format. Ex: “4.5”

Points, the unit of measure for this property, are a standard unit of measure for printing. See the chart above to convert inches to points, if necessary.

SetTTParameterWidth#

Syntax:

SetTTParameterWidth(String ParameterWidth);

Return Type:

Void

Optional.

Input: String Value.

Scales the width of container tags.

The value of this property is a multiplier that controls how wide the container tags will print. 1.0 = the default size. 1.05 = 5% wider. 0.95 = 5% narrower.

SetTTParameterHeight#

Syntax:

SetTTParameterHeight(String ParameterHeight);

Return Type:

Void

Optional.

Input: String Value.

Scales the height of container tags.

The value of this property is a multiplier that controls how tall the container tags will print. 1.0 = the default size. 1.05 = 5% taller. 0.95 = 5% shorter.

Standard-Only Methods#

SetSTD_Auto_5dg_Scheme#

Syntax:

SetSTD_Auto_5dg_Scheme(Boolean EnableAuto5DigitScheme);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is True.

If set to True, enables the Standard Automation 5-Digit Scheme.

If set to False, it will be disabled.

SetSTD_Auto_5dg#

Syntax:

SetSTD_Auto_5dg(Boolean EnableAuto5Digit);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is True.

If set to True, enables the Standard Automation 5-Digit.

If set to False, it will be disabled.

SetSTDNonProfit#

Syntax:

SetSTDNonProfit(Boolean EnableNonProfit);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to True, enables Non-Profit postage rates for Standard Mail.

If set to False, normal Standard Mail rates will be used.

SetIgnoreDSF#

Syntax:

SetIgnoreDSF(Boolean WillIgnoreDSF);

Return Type:

Void

Optional.

Input: Boolean Value. Default setting is False.

If set to True, the Delivery Sequence File (DSF) for walk sequence sorting will be ignored.

If set to False, it will not.

This property should only be used when using a list purchased from a list broker who can provide documentation that the list’s walk sequence is based on Computerized Delivery Sequence (CDS) data.

Destinations Properties#

SetProduceDropShipForms#

Syntax:

SetProduceDropShipForms(Boolean WillProduceDropShipForms);

Return Type:

Void

Optional.

Input: Boolean Value.

This method allows you to produce form 8285 and 3602C. These forms are required for drop shipping. On a correct call to the method it will return a value of true.

SetPOMasNDC#

Syntax:

SetPOMasNDC(Boolean IsPOMaNDC);

Return Type:

Void

Optional.

Input: Boolean Value.

Call and set to True to indicate that the Post Office of Mailings is also an Network Distribution Center (NDC).

Normally, 200 mail pieces are required to claim the NDC destination discount. If your Post Office of Mailing is an NDC, the USPS waives this requirement.

Do not call if the Post Office of Mailings is not an NDC.

SetNDCCity#

Syntax:

SetNDCCity(String City);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the city containing of a Network Distribution Center.

SetNDCState#

Syntax:

SetNDCState(String State);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the state containing of a Network Distribution Center.

SetNDCZip#

Syntax:

SetNDCZip(String ZIP);

Return Type:

Void

Optional.

Input: String Value.

Sets the ZIP Code of a Network Distribution Center.

This is normally the first three digits of the ZIP codes serviced by the NDC.

After setting the SetNDCCity, SetNDCState, and SetNDCZip properties, call the AddNDC method to add the NDC to the list of facilities used for the current presort operation.

AddNDC#

Syntax:

AddNDC();

Returns:

Added Successfully

Return Type:

Boolean

Optional.

Return: Boolean Value.

Uses the current values of the SetNDCCity, SetNDCState, and SetNDCZip properties to add an NDC to the list of facilities used for the current presort operation.

If a True value is returned, the NDC is successfully added.

If a False value is returned, it is an invalid destination. One or more of the properties referenced were not populated before calling this method or the destination is not an NDC.

SetPOMasSCF#

Syntax:

SetPOMasSCF(Boolean IsPOMaSCF);

Return Type:

Void

Optional.

Input: Boolean Value.

Call and set to True to indicate that the Post Office of Mailing is also an Sectional Center Facility (SCF).

Normally, 200 mail pieces are required to claim the SCF destination discount. If your Post Office of Mailing is an SCF, the USPS waives this requirement.

Do not call if the Post Office of Mailings is not an SCF.

SetSCFCity#

Syntax:

SetSCFCity(String City);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the city containing a Sectional Center Facility.

SetSCFState#

Syntax:

SetSCFState(String State);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the state containing of a Sectional Center Facility.

SetSCFZip#

Syntax:

SetSCFZip(String ZIP);

Return Type:

Void

Optional.

Input: String Value.

Sets the ZIP Code of a Sectional Center Facility.

This is normally the first three digits of the ZIP codes serviced by the SCF.

After setting the SetSCFCity, SetSCFState, and SetSCFZip properties, call the AddSCF method to add the SCF to the list of facilities used for the current presort operation.

AddSCF#

Syntax:

AddSCF();

Returns:

Added Successfully

Return Type:

Boolean

Optional.

Return: Boolean Value.

Uses the current values of the SetSCFCity, SetSCFState, and SetSCFZip properties to add an SCF to the list of facilities used for the current presort operation.

If a True value is returned, the SCF is successfully added.

If a False value is returned, it is an invalid destination. One or more of the properties referenced were not populated before calling this method or the destination is not an SCF.

SetDDUCity#

Syntax:

SetDDUCity(String City);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the city containing of a Destination Delivery Unit.

SetDDUState#

Syntax:

SetDDUState(String State);

Return Type:

Void

Optional. Input: String Value. Sets the name of the state containing of a Destination Delivery Unit.

SetDDUZip#

Syntax:

SetDDUZip(String ZIP);

Return Type:

Void

Optional.

Input: String Value.

Sets the main ZIP Code serviced by a Destination Delivery Unit.

If the DDU facility services more than one five-digit ZIP Code, add these ZIP Codes one at a time using the SetDDUMoreZip property.

After setting the SetDDUCity, SetDDUState, and SetDDUZip properties, call the AddDDU method to add the DDU to the list of facilities used for the current presort operation.

SetDDUMoreZip#

Syntax:

SetDDUMoreZip(String ZIP);

Return Type:

Void

Optional.

Input: String Value.

Sets additional ZIP codes serviced by the same Destination Delivery Unit, one at time.

If the current DDU services more than one five-digit ZIP Code, use this property to add these ZIP codes, one at a time, before calling the AddDDU method.

AddDDU#

Syntax:

AddDDU();

Returns:

Added Successfully

Return Type:

Boolean

Optional.

Input: String Value.

This method uses the current values of the SetDDUCity, SetDDUState, and SetDDUZip properties to add an DDU to the list of facilities used for the current presort operation.

This method will return a True value if the DDU is successfully added. If one or more of the related properties (SetDDUZip, SetDDUCity, and SetDDUState) were not populated before calling this method, it will return a zero or false value. Check the GetParametersErrorString method to determine the cause of the error.

Processing Methods#

ProduceReports#

Syntax:

ProduceReports(String Path, String Name);

Returns:

Reports Were Produced

Return Type:

Boolean

Optional.

Input: String Path, String Name.

Sets a file path, a file name, then creates and saves a PDF file containing the Mailing Summary, Qualification Reports (QR), Container Tags (TT), Presort Settings Report (PP) and Postage Statement (PS.)

The String Path must be a valid path to an existing directory. It must be called before a call to the DoPresort method.

Naming Conventions:

Mailing Summary, Qualification Reports, Container Tags and Presort Settings Reports:

Report Type_Mail Class_Piece Type_Qualification Type_
   String Name.File Extension

Postage Statement:

Postage Statement Form Number_String Name.File Extension

Return: Boolean Value.

If a True value is returned, the requirements were met and the PDF files will be generated.

If a False value is returned, the requirements were not met. Call GetInitializeErrorString to determine the cause.

DoPresort#

Syntax:

DoPresort();

Returns:

Successful

Return Type:

Boolean

Required.

Launches the presort operation for all records previously submitted via the AddRecord method according to any settings specified prior to calling this method.

DoPresort first checks to see if your mailing meets the minimum requirements for the selected mail class and sortation.

After a successful call to this method, use the GetRecord, GetFirstRecord, and GetNextRecord methods to retrieve the presort data for each address record.

Return: Boolean Value.

If a True value is returned, the operation was sucessful.

If a False value is returned, an error occurred. Call GetParametersErrorString to determine the cause.

SetPresortSettings#

Syntax:

SetPresortSettings(enum SortationCode);

Returns:

Settings In Use

Return Type:

String

Required.

Input: Enumerated Value.

Sets the sortation options to use, including Mail Class, mail piece type, and automation settings.

If this method is not called, an error will occur when you call DoPresort.

Return: String Value.

Returns a list of settings being used, separated by a forward-slash character.

For languages that do not support named enumerations, use the long integer value shown. The possible values are listed below.

First-Class Only:

Value

Enumerated Value

Description

1

FCM_LTR_AUTO_NONAUTO

First Class Mail, Letter, Automation & Non-Automation Sorts

2

FCM_LTR_AUTO

First Class Mail, Letter, Automation Sortations Only

3

FCM_LTR_NONAUTO

First Class Mail, Letter, Non-automation Sortation Only

4

FCM_LTR_NONMACH

First Class Mail, Letter, Non-machinable

41

FCM_POSTCARD_AUTO_NONAUTO

First Class Mail, Post Card, Automation & Non-Automation Sorts

42

FCM_POSTCARD_AUTO

First Class Mail, Post Card, Automation Sortations Only

43

FCM_POSTCARD_NONAUTO

First Class Mail, Post Card, Non-automation Sortation Only

51

FCM_FLAT_COTray

First Class Mail, Flat, Automation and Non-automation sorts, Co-traying enabled.

52

FCM_FLAT_AUTO

First Class Mail, Flat, Automation-eligible pieces only.

53

FCM_FLAT_NONAUTO

First Class Mail, Flat, Non-automation pieces only.

54

FCM_FLAT_DISABLE_COTRAY

First Class Mail, Flat, Automation and Non-automation pieces, Co-traying disabled.

55

FCM_FLAT_COTRAY_FSM1000

First Class Mail, Flat, Automation and Non-automation pieces, Co-traying enabled, Use FSM1000 sorting hardware.

56

FCM_FLAT_Disable_COTRAY_FSM1000

First Class Mail, Flat, Automation and Non-automation pieces, Co-sacking disabled, Use FSM1000 sorting hardware.

57

FCM_FLAT_AUTO_FSM1000

First Class Mail, Flat, Automation pieces, Use FSM1000 sorting hardware.

58

FCM_FLAT_NONAUTO_FSM1000

First Class Mail, Flat, Non-automation pieces, Use FSM1000 sorting hardware.

Standard Only:

Value

Enumerated Value

Description

101

STD_LTR_ECRRT_AUTO_NONAUTO

Standard Mail, Letter, Enhanced Carrier Route, Automation and Non-automation pieces.

102

STD_LTR_ECRRT_NONAUTO

Standard Mail, Letter, Enhanced Carrier Route, Non-automation pieces.

103

STD_LTR_AUTO_NONAUTO

Standard Mail, Letter, Automation and Non-automation pieces.

104

STD_LTR_AUTO

Standard Mail, Letter, Automation pieces.

105

STD_LTR_NONAUTO

Standard Mail, Letter, Non-automation pieces.

106

STD_LTR_NONMACH

Standard Mail, Letter, Non-machinable pieces.

107

STD_LTR_ECRRT_NONMACH

Standard Mail, Letter, Enhanced Carrier Route, Non-machinable pieces.

108

STD_LTR_ECRRT_AUTO

Standard Mail, Letter, Enhanced Carrier Route, Automation

109

STD_LTR_ECRRT

Standard Mail, Letter, Enhanced Carrier Route, Automation and Non-automation pieces

151

STD_FLAT_ECRRT_COSACK

Standard Mail, Flat, Enhanced Carrier Route, Automation and Non-automation pieces, Co-sacking enabled.

152

STD_FLAT_ECRRT_DISABLE_COSACK

Standard Mail, Flat, Enhanced Carrier Route pieces only, Co-sacking disabled.

153

STD_FLAT_COSACK

Standard Mail, Flat, Automation and Non-automation pieces, Co-sacking enabled.

154

STD_FLAT_DISABLE_COSACK

Standard Mail, Flat, Automation and Non-automation pieces, Co-sacking disabled.

155

STD_FLAT_AUTO

Standard Mail, Flat, Automation pieces.

156

STD_FLAT_NONAUTO

Standard Mail, Flats, Non-automation pieces.

157

STD_FLAT_ECRRT_AUTO

Standard Mail, Flat, Enhanced Carrier Route Automation pieces only.

158

STD_FLAT_ECRRT_NONAUTO

Standard Mail, Flats, Enhanced Carrier Route, Non-automation pieces.

159

STD_FLAT_ECRRT

Standard Mail, Flats, Enhanced Carrier Route, Automation and Non-automation pieces.

UpdateParameters#

Syntax:

UpdateParameters();

Returns:

Are Properties In Range

Return Type:

Boolean

Required.

Validates the mail piece dimension properties, verifying that they are within the correct ranges for the options selected using PresortSettings, before calling AddRecord or DoPresort.

The following properties are checked to be within the correct ranges:

SetPieceHeight, SetPieceLength, SetPieceThickness, and SetPieceWeight.

Valid ranges for these properties can change depending on the mail class and piece type selected. Call this method after calling the above properties and PresortSettings, before making any additional calls to the AddRecord or DoPresort methods.

Return: Boolean Value.

If a False value is returned, all values are inside the valid ranges for the selected mail class.

If a True value is returned, an error occurred. Call GetParametersErrorString to determine the cause.

AddRecord#

Syntax:

AddRecord();

Returns:

Add Record Successful

Return Type:

Boolean

Required.

Adds a new record to the current list.

AddRecord requires SetRecordID and SetZip be set. Make sure to call SetPlus4 to receive the largest possible postage discount.

Repeat this method for each address record on your list.

Return: Boolean Value.

If a True value is returned, this method was successful.

If a False value is returned, an error occurred. Call GetParametersErrorString to determine the cause.

GetRecord#

Syntax:

GetRecord(String RecordID);

Returns:

Found Record

Return Type:

Boolean

Optional.

Input: String Value.

Retrieves a record from the presorted list based on the record ID submitted to the method. Matches the contents of SetRecordID property passed to the AddRecord method. Populates the result property after a successful call to DoPresort.

This is an alternate way to retrieve the results of a call to DoPresort. You can retrieve the record ID from your database, pass that information to this method and retrieve a specific record. This allows you to retrieve the presorted records in the order in which they appear in the original database and write this information back. You can then later use database queries to retrieve the data, sorting according to the value of the GetSequenceNumber property.

A successful call to this method populates the following properties:

GetRecordID            GetSequenceNumber       GetTrayNumber
GetEndorsementLine     GetBundleNumber         GetServiceTypeID
GetBarcodeID

Return: Boolean Value.

If a True value is returned, the properties were successfully populated.

If a False value is returned, an error occurred. The record ID passed in does not match a record ID in the current presorted list or DoPresort has not been called.

GetFirstRecord#

Syntax:

GetFirstRecord();

Returns:

Found Record

Return Type:

Boolean

Optional.

Retrieves the first record in the presorted list and populates the return values of properties described below with the presort information related to that record.

It cannot be called until a successful call has been made to the DoPresort method. Use GetFirstRecord and GetNextRecord to retrieve the results in the order created by a call to DoPresort. This is useful when writing the presorted records to a new database or file, rather than to the original database or file.

A successful call to this method populates the following properties with values for the first mail piece in the presorted list:

GetRecordID            GetSequenceNumber       GetTrayNumber
GetEndorsementLine     GetBundleNumber         GetServiceTypeID
GetBarcodeID

Return: Boolean Value. If a True value is returned, the call was successful and the first record was retrieved.

If a False value is returned, an error occurred. The ProduceReports method has not been called.

GetNextRecord#

Syntax:

GetNextRecord();

Returns:

Found Record

Return Type:

Boolean

Optional.

Retrieves the next record in the presorted list and populates the related properties with presort information related to that record.

It cannot be called until DoPresort and GetFirstRecord have been called. An error will occur if the last record in the presorted list has already been retrieved by a previous call to GetFirstRecord or GetNextRecord.

A successful call to this method populates the following properties:

GetRecordID            GetSequenceNumber       GetTrayNumber
GetEndorsementLine     GetBundleNumber         GetServiceTypeID
GetBarcodeID

Return: Boolean Value.

If a True value is returned, the record was retrieved and the properties were successfully populated.

If a False value is returned, there are no more records in the presorted list.

SetProduceIMBCode#

Syntax:

SetProduceIMBCode(Boolean UseIMBCode);

Return Type:

Void

Optional.

Input: Boolean Value.

If set to True, Intelligent Mail barcodes will be included with the presort operation.

Do not call this method if you do not want to include Intelligent Mail barcodes.

In order to successfully return an IMB, you must input a ZIP, Plus4 and Delivery Point Code.

You must install the usps4cb.ttf font to use Intelligent Mail barcodes. This font is located in the ‘Extras’ folder on the install disk. When printing the barcodes in this font, use 16pt as the font size.

SetACSCodeSettings#

Syntax:

SetACSCodeSettings(enum ACSCode);

Returns:

Successful

Return Type:

Boolean

Optional.

Input: Enumerated Value.

Sets the value for STID depending on what type of move update method is used.

Return: Boolean Value.

First-Class Only:

Type

Move Update Method

IMb Trace

Name

Enum

Basic

ACS

OFF

FCM_ACS_ASR

1

Basic

ACS

OFF

FCM_ACS_ASR2

2

Basic

ACS

OFF

FCM_ACS_CSR

3

Basic

ACS

OFF

FCM_ACS_CSR2

4

Basic

ONCODE ACS

OFF

FCM_ACS_ASR_ONECODE

5

Basic

ONCODE ACS

OFF

FCM_ACS_ASR2_ONECODE

6

Basic

ONCODE ACS

OFF

FCM_ACS_CSR_ONECODE

7

Basic

ONCODE ACS

OFF

FCM_ACS_CSR2_ONECODE

8

Basic

ACS

ON

FCM_ACS_ASR_TRACE

11

Basic

ACS

ON

FCM_ACS_ASR2_TRACE

12

Basic

ACS

ON

FCM_ACS_CSR_TRACE

13

Basic

ACS

ON

FCM_ACS_CSR2_TRACE

14

Basic

ONCODE ACS

ON

FCM_ACS_ASR_ONECODE_TRACE

15

Basic

ONCODE ACS

ON

FCM_ACS_CSR_ONECODE_TRACE

16

Full Service

ACS

OFF

FCM_ACS_ASR_FS

19

Full Service

ACS

OFF

FCM_ACS_ASR2_FS

20

Full Service

ACS

OFF

FCM_ACS_CSR_FS

21

Full Service

ACS

OFF

FCM_ACS_CSR2_FS

22

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_ASR_FS

23

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_ASR2_FS

24

Full Service

ACS

ON

FCM_ACS_ASR_FS_TRACE

27

Full Service

ACS

ON

FCM_ACS_ASR2_FS_TRACE

28

Full Service

ACS

ON

FCM_ACS_CSR_FS_TRACE

29

Full Service

ACS

ON

FCM_ACS_CSR2_FS_TRACE

30

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_ASR_FS_TRACE

31

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_ASR2_FS_TRACE

32

Basic

ONCODE ACS

ON

FCM_ACS_ASR2_ONECODE_TRACE

35

Basic

ONCODE ACS

ON

FCM_ACS_CSR2_ONECODE_TRACE

36

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_CSR_FS

37

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_CSR2_FS

38

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_CSR_FS_TRACE

39

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_CSR2_FS_TRACE

40

Basic

ACS

OFF

FCM_ACS_RSR2

41

Basic

ACS

OFF

FCM_ACS_TRSR2

42

Basic

ONCODE ACS

OFF

FCM_ACS_RSR2_ONECODE

43

Basic

ONCODE ACS

OFF

FCM_ACS_TRSR2_ONECODE

44

Basic

ACS

ON

FCM_ACS_RSR2_TRACE

45

Basic

ACS

ON

FCM_ACS_TRSR2_TRACE

46

Basic

ONCODE ACS

ON

FCM_ACS_RSR2_ONECODE_TRACE

47

Basic

ONCODE ACS

ON

FCM_ACS_TRSR2_ONECODE_TRACE

48

Full Service

ACS

OFF

FCM_ACS_RSR2_FS

49

Full Service

ACS

OFF

FCM_ACS_TRSR2_FS

50

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_RSR2_FS

51

Full Service

ACS

OFF

FCM_FULL_SERVICE_ACS_TRSR2_FS

52

Full Service

ACS

ON

FCM_ACS_RSR2_FS_TRACE

53

Full Service

ACS

ON

FCM_ACS_TRSR2_FS_TRACE

54

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_RSR2_FS_TRACE

55

Full Service

ACS

ON

FCM_FULL_SERVICE_ACS_TRSR2_FS_TRACE

56

Basic

Alt Method

OFF

FCM_MANUAL_CORRECTION

9

Full Service

Alt Method

OFF

FCM_MANUAL_CORRECTION_FS

25

Full Service

Alt Method

ON

FCM_MANUAL_CORRECTION_FS_TRACE

33

Basic

Alt Method

ON

FCM_MANUAL_CORRECTION_TRACE

17

Basic

Ancillary Service

OFF

FCM_MANUAL_CORRECTION

9

Full Service

Ancillary Service

OFF

FCM_MANUAL_CORRECTION_FS

25

Full Service

Ancillary Service

ON

FCM_MANUAL_CORRECTION_FS_TRACE

33

Basic

Ancillary Service

ON

FCM_MANUAL_CORRECTION_TRACE

17

Basic

Mulitple

OFF

FCM_MANUAL_CORRECTION

9

Full Service

Mulitple

OFF

FCM_MANUAL_CORRECTION_FS

25

Full Service

Mulitple

ON

FCM_MANUAL_CORRECTION_FS_TRACE

33

Basic

Mulitple

ON

FCM_MANUAL_CORRECTION_TRACE

17

Basic

N/A Alternative Address

OFF

FCM_MANUAL_CORRECTION

9

Full Service

N/A Alternative Address

OFF

FCM_MANUAL_CORRECTION_FS

25

Full Service

N/A Alternative Address

ON

FCM_MANUAL_CORRECTION_FS_TRACE

33

Basic

N/A Alternative Address

ON

FCM_MANUAL_CORRECTION_TRACE

17

Basic

N/A Alternative Address

ON

FCM_MANUAL_CORRECTION_TRACE

17

Basic

NCOA Link

OFF

FCM_MANUAL_CORRECTION

9

Full Service

NCOA Link

OFF

FCM_MANUAL_CORRECTION_FS

25

Full Service

NCOA Link

ON

FCM_MANUAL_CORRECTION_FS_TRACE

33

Basic

NCOA Link

ON

FCM_MANUAL_CORRECTION_TRACE

17

Full Service

None

OFF

FCM_NO_ADDR_CORRECTION_FS

26

Full Service

None

ON

FCM_NO_ADDR_CORRECTION_FS_TRACE

34

Basic

None

ON

FCM_NO_ADDR_CORRECTION_TRACE

18

Basic

None

OFF

FCM_NO_ADDR_CORRECTION

10

Standard Only:

Type

Move Update Method

IMb Trace

Name

Enum

Basic

ACS

OFF

STD_ACS_ASR

101

Basic

ACS

OFF

STD_ACS_CSR

102

Basic

ACS

OFF

STD_ACS_ASR2

125

Basic

ACS

OFF

STD_ACS_RSR2

126

Basic

ACS

ON

STD_ACS_ASR_TRACE

107

Basic

ACS

ON

STD_ACS_CSR_TRACE

108

Basic

ACS

ON

STD_ACS_ASR2_TRACE

129

Basic

ACS

ON

STD_ACS_RSR2_TRACE

130

Full Service

ACS

OFF

STD_ACS_ASR_FS

113

Full Service

ACS

OFF

STD_ACS_CSR_FS

114

Full Service

ACS

OFF

STD_FULL_SERVICE_ACS_ASR_FS

115

Full Service

ACS

OFF

STD_FULL_SERVICE_ACS_CSR_FS

116

Full Service

ACS

OFF

STD_ACS_ASR2_FS

133

Full Service

ACS

OFF

STD_ACS_RSR2_FS

134

Full Service

ACS

OFF

STD_FULL_SERVICE_ACS_ASR2_FS

135

Full Service

ACS

OFF

STD_FULL_SERVICE_ACS_RSR2_FS

136

Full Service

ACS

ON

STD_ACS_ASR_FS_TRACE

119

Full Service

ACS

ON

STD_ACS_CSR_FS_TRACE

120

Full Service

ACS

ON

STD_FULL_SERVICE_ACS_ASR_FS_TRACE

121

Full Service

ACS

ON

STD_FULL_SERVICE_ACS_CSR_FS_TRACE

122

Full Service

ACS

ON

STD_ACS_ASR2_FS_TRACE

137

Full Service

ACS

ON

STD_ACS_RSR2_FS_TRACE

138

Full Service

ACS

ON

STD_FULL_SERVICE_ACS_ASR2_FS_TRACE

139

Full Service

ACS

ON

STD_FULL_SERVICE_ACS_RSR2_FS_TRACE

140

Basic

Alt Method

OFF

STD_MANUAL_CORRECTION

105

Basic

Alt Method

ON

STD_MANUAL_CORRECTION_TRACE

111

Full Service

Alt Method

OFF

STD_MANUAL_CORRECTION_FS

117

Full Service

Alt Method

ON

STD_MANUAL_CORRECTION_FS_TRACE

123

Basic

Ancillary Service

OFF

STD_MANUAL_CORRECTION

105

Basic

Ancillary Service

ON

STD_MANUAL_CORRECTION_TRACE

111

Full Service

Ancillary Service

OFF

STD_MANUAL_CORRECTION_FS

117

Full Service

Ancillary Service

ON

STD_MANUAL_CORRECTION_FS_TRACE

123

Basic

Mulitple

OFF

STD_MANUAL_CORRECTION

105

Basic

Mulitple

ON

STD_MANUAL_CORRECTION_TRACE

111

Full Service

Mulitple

OFF

STD_MANUAL_CORRECTION_FS

117

Full Service

Mulitple

ON

STD_MANUAL_CORRECTION_FS_TRACE

123

Basic

N/A Alternative Address

OFF

STD_MANUAL_CORRECTION

105

Basic

N/A Alternative Address

OFF

STD_MANUAL_CORRECTION

105

Basic

N/A Alternative Address

ON

STD_MANUAL_CORRECTION_TRACE

111

Full Service

N/A Alternative Address

OFF

STD_MANUAL_CORRECTION_FS

117

Full Service

N/A Alternative Address

ON

STD_MANUAL_CORRECTION_FS_TRACE

123

Basic

NCOA Link

ON

STD_MANUAL_CORRECTION_TRACE

111

Full Service

NCOA Link

OFF

STD_MANUAL_CORRECTION_FS

117

Full Service

NCOA Link

ON

STD_MANUAL_CORRECTION_FS_TRACE

123

Basic

None

OFF

STD_NO_ADDR_CORRECTION

106

Basic

None

ON

STD_NO_ADDR_CORRECTION_TRACE

112

Full Service

None

OFF

STD_NO_ADDR_CORRECTION_FS

118

Full Service

None

ON

STD_NO_ADDR_CORRECTION_FS_TRACE

124

Basic

ONCODE ACS

OFF

STD_ACS_ASR_ONECODE

103

Basic

ONCODE ACS

OFF

STD_ACS_CSR_ONECODE

104

Basic

ONCODE ACS

OFF

STD_ACS_ASR2_ONECODE

127

Basic

ONCODE ACS

OFF

STD_ACS_RSR2_ONECODE

128

Basic

ONCODE ACS

ON

STD_ACS_ASR_ONECODE_TRACE

109

Basic

ONCODE ACS

ON

STD_ACS_CSR_ONECODE_TRACE

110

Basic

ONCODE ACS

ON

STD_ACS_ASR2_ONECODE_TRACE

131

Basic

ONCODE ACS

ON

STD_ACS_RSR2_ONECODE_TRACE

132

Output Properties#

All of the following properties are populated by a call to the GetRecord, GetFirstRecord, or GetNext Record methods after a successful call to the DoPresort method.

GetBarcodeID#

Syntax:

GetBarcodeID();

Returns:

Barcode ID

Return Type:

String

Optional.

Return: String Value.

Returns information needed to generate the Intelligent Mail barcode for the current mail piece.

GetBundleNumber#

Syntax:

GetBundleNumber();

Returns:

Bundle Number

Return Type:

Long Integer

Optional.

Return: Long Integer.

Returns the package, bundle or group number of the current record. Use this number for sorting your list before printing address labels.

GetBundleZipCode#

Syntax:

GetBundleZipCode();

Returns:

Bundle ZIP Code

Return Type:

String

Optional.

Return: String Value.

Returns the destination 3 or 5-digit ZIP Code for the bundle containing the current record.

GetCINCode#

Syntax:

GetCINCode();

Returns:

CIN Code

Return Type:

String

Optional.

Return: String Value.

Returns the 3-digit Content Identifier Number (CIN) Code for the current record.

GetEndorsementLine#

Syntax:

GetEndorsementLine();

Returns:

Endorsement Line

Return Type:

String

Optional.

Return: String Value.

Returns the Endorsement Line sort type code for the current record.

This value is usually included as the first line of the label, providing a shorthand for the ZIP Code, carrier route and sortation for the current piece. This code also helps match the label with the Qualification Report.

GetIMBAlphaCode#

Syntax:

GetIMBAlphaCode();

Returns:

IMB Alpha Code

Return Type:

String

Optional.

Return: String Value.

Returns an alphabetic representation of the Intelligent Mail barcode.

You must have SetProduceIMBCode to True for this property to return a value.

In order to successfully return an IMB, you must input a ZIP, Plus4 and Delivery Point Code.

For more information see “Intelligent Mail barcode” on page 108.

GetIMBNumericCode#

Syntax:

GetIMBNumericCode();

Returns:

IMB Numeric Code

Return Type:

String

Optional.

Return: String Value.

Returns a numeric representation of the Intelligent Mail barcode.

You must have SetProduceIMBCode to True for this property to return a value.

In order to successfully return an IMB, you must input a ZIP, Plus4 and Delivery Point Code.

For more information see “Intelligent Mail barcode” on page 108.

GetIMBSerialNumber#

Syntax:

GetIMBSerialNumber();

Returns:

IMB Serial Number

Return Type:

String

Optional.

Return: All Digits String Value.

Returns the Intelligent Mail barcode number.

You must have assigned a value to SetIMBSerialNumber for this property to return a value.

This allows you to retrieve the distinct number for each mail piece in the IMB.

For more information see “Intelligent Mail barcode” on page 108.

GetRecordID#

Syntax:

GetRecordID();

Returns:

Record ID

Return Type:

String

Optional.

Return: String Value.

Returns a unique value passed to the SetRecordID property before calling the DoPresort method. This links each record in the presorted list back to the corresponding address record in the original database.

GetSequenceNumber#

Syntax:

GetSequenceNumber();

Returns:

Sequence Number

Return Type:

Long Integer

Optional.

Return: Long Integer.

Returns the number which indicates the exact position of the current record when the list is sorted in presort order.

GetServiceTypeID#

Syntax:

GetServiceTypeID();

Returns:

Service Type ID

Return Type:

String

Optional.

Return: String Value.

Returns the service type ID which is part of the intelligent mail barcode.

GetTrayNumber#

Syntax:

GetTrayNumber();

Returns:

Tray Number

Return Type:

Long Integer

Optional.

Return: Long Integer.

Returns the container number for the current record.

GetTrayZipCode#

Syntax:

GetTrayZipCode();

Returns:

Tray Zip Code

Return Type:

String

Optional.

Return: String Value.

Returns the destination facility ZIP Code for the container of current record.

The TrayZIPCode is the 3- or 5-digit ZIP Code destination for the current container from the appropriate DMM Module L Labeling List or mail piece address depending upon the sortation level assigned.

GetZipAsString#

Syntax:

GetZipAsString();

Returns:

Zip As String

Return Type:

String

Optional.

Return: String Value.

Returns the ZIP Code for the current record.

Mail.Dat Properties#

Mail.dat is a database that contains industry standards for mailing, including presorting. This helps facilitate efficient communication among those providing mailing services. Required properties are only required if you will be using Mail.Dat.

ProduceMailDatFiles#

Syntax:

ProduceMailDatFiles(String DataPath, String FileName);

Returns:

Successful

Return Type:

Boolean

Required.

Input: Data Path String Value, File Name String Value.

Produces the Mail.Dat files.

SetPSPostOfficeOfMailingPlus4#

Syntax:

SetPSPostOfficeOfMailingPlus4(String PostOffice);

Return Type:

Void

Required.

Input: String Value.

Sets the Post Office of Mailing Plus4 code.

SetMDMachineID#

Syntax:

SetMDMachineID(String MachineID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Machine ID of the machine that applied the barcode to the mail piece.

SetMDJobID#

Syntax:

SetMDJobID(String JobID);

Return Type:

Void

Required.

Input: String Value.

Sets the Job ID, also known as the Mail.dat serial number. This value should be unique compared to all other Job IDs set.

SetMDHDRIDEAllianceVersion#

Syntax:

SetMDHDRIDEAllianceVersion(String IDEAlliance);

Return Type:

Void

Required.

Input: String Value.

Sets the IDEAlliance version number.

SetMDHDRLicensedUsersJobNumber#

Syntax:

SetMDHDRLicensedUsersJobNumber(String LicensedUsersJobNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the licensed user’s internal job number.

SetMDHDRJobNameTitleIssue#

Syntax:

SetMDHDRJobNameTitleIssue(String JobNameTitleIssue);

Return Type:

Void

Required.

Input: String Value.

Sets any applicable job, title-issue, campaign name, or description.

SetMDHDRFileSource#

Syntax:

SetMDHDRFileSource(String FileSource);

Return Type:

Void

Required.

Input: String Value.

Sets the name of the originator supplying the files.

SetMDHDRUserLicenseCode#

Syntax:

SetMDHDRUserLicenseCode(String UserLicenseCode);

Return Type:

Void

Optional.

Input: String Value.

Sets the User License Code for Mail.dat. This code is given to you by IDE Alliance.

SetMDHDRContactEmail#

Syntax:

SetMDHDRContactEmail(String ContactEmail);

Return Type:

Void

Required.

Input: String Value.

Sets the email of an individual for support at the originator of this file.

SetMDHDRContactName#

Syntax:

SetMDHDRContactName(String ContactName);

Return Type:

Void

Required.

Input: String Value.

Sets the name of an individual for support at the originator of this file.

SetMDHDRContactPhone#

Syntax:

SetMDHDRContactPhone(String ContactPhone);

Return Type:

Void

Required.

Input: String Value.

Sets the phone number of the individual listed in MDHDRContactName.

SetMDHDReDocSenderCRID#

Syntax:

SetMDHDReDocSenderCRID(String DocSenderCRID);

Return Type:

Void

Optional.

Input: String Value.

Sets the CRID of the document sender. This is the USPS ID.

SetMDHDRMailDatSoftwareVendorName#

Syntax:

SetMDHDRMailDatSoftwareVendorName(String MailDatSoftwareVendorName);

Return Type:

Void

Required.

Input: String Value.

Sets the name of the author of this Mail.dat software as appended to this record.

SetMDHDRMailDatSoftwareProductsName#

Syntax:

SetMDHDRMailDatSoftwareProductsName(String MailDatSoftwareProductsName);

Return Type:

Void

Required.

Input: String Value.

Sets the name of the product creating the Header and applicable data in associated records.

SetMDHDRMailDatSoftwareVersion#

Syntax:

SetMDHDRMailDatSoftwareVersion(String MailDatSoftwareVersion);

Return Type:

Void

Required.

Input: String Value.

Sets the version of the software creating the transmitted Mail.dat.

SetMDHDRMailDatSoftwareVendorEmail#

Syntax:

SetMDHDRMailDatSoftwareVendorEmail(String MailDatSoftwareVendorEmail);

Return Type:

Void

Required.

Input: String Value.

Sets the email address of the author of this software.

SetMDSEGVerificationFacilityName#

Syntax:

SetMDSEGVerificationFacilityName(String VerificationFacilityName);

Return Type:

Void

Optional.

Input: String Value.

Sets the name of the Mailing Facility where verification occurs.

SetMDSEGVerificationFacilityZipPlus4#

Syntax:

SetMDSEGVerificationFacilityName(String VerificationFacilityName);

Return Type:

Void

Optional.

Input: String Value.

Sets the ZIP + 4 of the Mailing Facility where verification occurs.

SetMDSEGDescription#

Syntax:

SetMDSEGDescription(String SegmentationDescription);

Return Type:

Void

Required.

Input: String Value.

Sets the description of segmentation. The segmentation should be at single mail-stream level. Describe string, list, mail-stream characteristics which this particular set of names exhibits. For example:

Single List Segment:

Spring - Re-mail, prospects, $100 Off

Selective Bind Segment:

Spring - Re-mail, all versions

SetMDMPUName#

Syntax:

SetMDMPUName(String MPUName);

Return Type:

Void

Required.

Input: String Value.

Sets the Mail Piece Unit Name. This name is used to identify a specific marketing version within a list, bind, and distribution environment.

SetMDMPUDescription#

Syntax:

SetMDMPUDescription(String MPUDescription);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mail Piece Unit Description. This is a unique name or code for each specific version being created within this mailing.

SetMDMPADescription#

Syntax:

SetMDMPADescription(String MPADescription);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mailer Postage Account Description.

SetMDMPAMailingAgentMailerID#

Syntax:

SetMDMPAMailingAgentMailerID(String MailingAgentMailerID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mailer ID of the Mailing Agent.

SetMDCPTComDescription#

Syntax:

SetMDCPTComDescription(String ComponentDescription);

Return Type:

Void

Optional.

Input: String Value.

Sets the Component Description. This is a unique name or code for each specific portion of the mail piece. This property can carry an absolute reference to the component while the component ID is a shorthand for reference to the component’s role within the mailing facilities’ postage analysis. If used, it must have a value.

SetMDCPTMailOwnerID#

Syntax:

SetMDCPTMailOwnerID(String MailOwnerID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mail Owner ID in the component record. This is the USPS ID.

SetMDMPAMailOwnerPermitNumber#

Syntax:

SetMDMPAMailOwnerPermitNumber(String MailOwnerPermitNumber);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mail Owner Permit Number in the component record.

SetMDMPAMailOwnerPermitType#

Syntax:

SetMDMPAMailOwnerPermitType(String MailOwnerPermitType);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mail Owner Permit Type in the component record.

SetMDCPTOwnerCRID#

Syntax:

SetMDCPTOwnerCRID(String OwnerCRID);

Return Type:

Void

Optional.

Input: String Value.

Sets the CRID of the Mail Owner in the component record. This is the USPS ID.

SetMDCPTMailOwnersMailingRefID#

Syntax:

SetMDCPTMailOwnersMailingRefID(String MailOwnersMailingRefID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Mail Owner’s Mailing Reference ID. This is the Mail Owner’s chosen value to represent mailing to the USPS.

SetMDCPTPostalPriceIncID#

Syntax:

SetMDCPTPostalPriceIncID(String PostalPriceIncID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Postal Price Incentive ID. This is a USPS provided incentive ID.

SetMDCPTPostalPriceIncType#

Syntax:

SetMDCPTPostalPriceIncID(String PostalPriceIncID);

Return Type:

Void

Optional.

Input: String Value.

Sets the Postal Price Incentive type. The Postal Price Incentive types are:

SetMDCPTContentOfMail#

Syntax:

SetMDCPTContentOfMail(String ContentOfMail);

Return Type:

Void

Optional.

Input: String Value.

Sets the Content of the Mail. This identifies unique products within the mailing.

Value

Description

A

Reply Envelope or Reply Card

B

Contents NOT required to be mailed FCM

C

DVD/CD or other disk

E

Product Sample

F

Round Trip ONLY: One DVD/CD or other disk (Can be LT or FL)

For First-Class Mail, any possible combination of A, B, and C includes:

Value

Description

A1

A and B

A2

A and C

A3

A, B, and C

B1

B and C

For Standard Mail, any possible combination of C and E includes:

Value

Description

C1

C and E

SetMDCPTStandParcelType#

Syntax:

SetMDCPTStandParcelType(String StandParcelType);

Return Type:

Void

Optional.

Input: String Value.

Sets the Standard Parcel type. The Standard Parcel types are:

Value

Description

M

Marketing

F

Fulfillment

SetMDCPTStandFlatType#

Syntax:

SetMDCPTStandFlatType(String StandFlatType);

Return Type:

Void

Optional. Input: String Value. Sets the Standard Flat type. The Standard Flat types are:

Value

Description

C

Catalog

N

Not a Catalog

SetMDCPTUserOptField#

Syntax:

SetMDCPTUserOptField(String UserOptField);

Return Type:

Void

Optional.

Input: String Value.

Sets the User Option field. This is not to be used for communication between parties. It is specifically for user usage.

SetMDCSMCSAAgreementID#

Syntax:

SetMDCSMCSAAgreementID(String CSAAgreementID);

Return Type:

Void

Optional.

Input: String Value.

Sets the CSA Agreement ID generated by the USPS.

Palletization#

SetProducePallets#

Syntax:

SetProducePallets(Boolean WillProducePallets);

Returns:

Successful

Return Type:

Boolean

Optional.

Input: Boolean Value.

Enables palletization. This method cannot be called when mailing Flat pieces with Cosack or Cotrayed disabled.

GetPalletLabelLine1#

Syntax:

GetPalletLabelLine1();

Returns:

Pallet Label Line 1

Return Type:

String

Optional.

Return: Boolean Value.

Enables palletization. This method cannot be called when mailing Flat pieces with Cosack or Cotrayed disabled.

GetPalletLabelLine2#

Syntax:

GetPalletLabelLine2();

Returns:

Pallet Label Line 2

Return Type:

String

Optional.

Return: String Value.

Returns the pallet label line 2.

GetPalletNumber#

Syntax:

GetPalletNumber();

Returns:

Pallet Number

Return Type:

Long Integer

Optional.

Return: Long Integer.

Returns the pallet number.

GetPalletSortLevel#

Syntax:

GetPalletSortLevel();

Returns:

Pallet Sort Level

Return Type:

String

Optional.

Return: String Value.

Returns the pallet sort level.

GetPalletsTotal#

Syntax:

GetPalletsTotal();

Returns:

Total Number of Pallets

Return Type:

Long Integer

Optional.

Return: Long Integer.

Returns the total number of pallets.

GetPalletZipCode#

Syntax:

GetPalletZipCode();

Returns:

Pallet Zip Code

Return Type:

String

Optional.

Return: String Value.

Returns the pallet ZIP Code.

Result Codes#

For details of all result codes please visit here.

Contents