USPS Integrator ExpressLabels Component : ExpressLabels OCX, ExpressLabels .NET Component, ExpressLabels Class, ExpressLabels Bean, ExpressLabels Object

Available in: USPS

ExpressLabels Component [IBiz USPS Integrator V2]

Properties Methods Events Configuration Settings

Generates a USPS Express Mail shipping label complete with addresses and barcode.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component generates an Express Mail shipping label and if requested, a Customer Online Record. This record can be printed at the same time as the shipping label or stored electronically and printed on demand. There are two options in how the labels are returned: either together on the same page or separated and printed on separate pages by using the SeparateReceipt property;

In addition to the normal To and From address fields, there are several properties available that control how the package is delivered. For instance, If you are sending to a business you know is closed on the weekend or holiday, you should set NoWeekendDelivery and/or NoHolidayDelivery to True. Normally Express Mail packages require a signature, but you can waive that requirement by setting the WaiveSignature property. You can also indicate you're shipping with a FlatRate envelope. Finally, you can request that the USPS server looks up and standardizes the destination address you supplied with the StandardizeAddress property.

For instance:

ExpressLabels1.FromFirm = "XYZ Corporation" ExpressLabels1.FromAddress2 = "1234 Etailer Dr." ExpressLabels1.FromCity = "Los Angeles" ExpressLabels1.FromState = "CA" ExpressLabels1.FromZipCode = "90052" ExpressLabels1.FromZip4 = "1234" ExpressLabels1.FromPhone = "5551234567" ExpressLabels1.ToFirstName = "Linda" ExpressLabels1.ToLastName = "Shopper" ExpressLabels1.ToAddress1 = "Apt. 3C" ExpressLabels1.ToAddress2 = "100 Main St." ExpressLabels1.ToCity = "New York" ExpressLabels1.ToState = "NY" ExpressLabels1.ToZipCode = "10010" ExpressLabels1.ToZip4 = "1234" ExpressLabels1.FlatRate = True ExpressLabels1.NoWeekendDelivery = True ExpressLabels1.StandardizeAddress = False ExpressLabels1.ImageType = itPDF ExpressLabels1.ShippingLabelFile = "c:\expresslabel.pdf" ExpressLabels1.GetExpressMailLabel()

If the StandardizeAddress property was set to True, then after a successful label request the above address properties will show a standardized address as returned from the USPS server. In addition, a successful request also returns the following properties:


Postage	The amount of postage required for this package.
TrackingNumber	The TrackingNumber returned in the response allows you to access information (either on the Internet or with the TRACKANDCONFIRM component) about the delivery status of this package/
ShippingLabel	Binary shipping label image.

If ShippingLabelFile was specified, the label will also be saved to disk.

Note: The tracking number is used to uniquely identify each piece of Express Mail and record acceptance and delivery information. This information is used to measure service performance and identify service failures in response to refund requests.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


CustomerReceipt	Image of the Customer Online Record.
CustomerReceiptFile	Filename for CustomerReceipt (optional).
CustomerRefNo	User-assigned number for internal use.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	Port of the firewall to connect to.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FlatRate	Flat Rate request for express mail service.
FromAddress1	An apartment or suite number that the package is being shipped from.
FromAddress2	Sender's street address.
FromCity	Sender's city.
FromFirm	Sender's company name.
FromFirstName	Sender's first name.
FromLastName	Sender's last name.
FromPhone	Sender's phone number.
FromState	Sender's state.
FromZip4	Sender's extended Zip Code (ZIP+4).
FromZipCode	Sender's Zip Code.
ImageType	Type of label image.
LabelDate	Date package will be mailed.
MailingLocation	Postal Office Zip Code where the item will be mailed (if different from FromZipCode).
NoHolidayDelivery	Allows you to defer delivery on a holiday.
NoWeekendDelivery	Allows you to defer delivery on the weekend.
Password	Password to use for logging in to the USPS Server.
Postage	Amount of postage required to mail a package.
RecipientEmail	E-mail address of the person receiving optional email confirmation.
RecipientName	Name of the person or company receiving optional email confirmation.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
SenderEmail	Sender's e-mail address, used to send email confirmation.
SenderName	Sender's name, used to send email confirmation.
SeparateReceipt	Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.
Server	URL for the USPS server where the requests are sent.
ShippingLabel	Image of the shipping label retrieved by USPS Server.
ShippingLabelFile	Filename and location to save the ShippingLabel to.
StandardizeAddress	Checks the delivery address against the USPS Address Matching System.
Timeout	A timeout for the component.
ToAddress1	An apartment or suite number that the package is being shipped to.
ToAddress2	Recipient's street address.
ToCity	Recipient's city.
ToFirm	Recipient's company name.
ToFirstName	Recipient's first name.
ToLastName	Recipient's last name.
ToPhone	Recipient's phone number.
ToState	Recipient's state.
ToZip4	Recipient's extended Zip Code (ZIP+4).
ToZipCode	Recipient's Zip Code.
TrackingNumber	Tracking Number of the package shipped provided by the USPS Server.
UserId	User ID for logging in to the USPS Server.
WaiveSignature	Indicates if you request waiver of signature.
WeightInOunces	Estimated weight of the package to be shipped.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


Config	Sets or retrieves a component configuration setting.
GetExpressMailLabel	retrieves a USPS Express Mail ShippingLabel, CustomerReceipt, and TrackingNumber along with the required Postage. Optionally checks the shipping address and provides the addressee with email notification.
Reset	Reset the internal state of the component and all properties to their default values.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
Certify	Certify/Test mode for label components.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EMCAAccount	For future use.
EMCAPassword	For future use.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FullResponse	Contains the full response returned by the USPS server.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
ImageParameters	For future use.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
LabelOption	For future use.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
Overwrite	Determines whether label files will be overwritten.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if Basic authentication is to be used for the proxy.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification
SocketHandle	The handle of the main socket used by the component.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)
XPath	Used to retrieve data at any place within the response.