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

Available in: USPS

ConfirmationLabels Component [IBiz USPS Integrator V2]

Properties Methods Events Configuration Settings

Generates a delivery or signature confirmation numbers and labels.

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 either Delivery or Signature Confirmation labels that can be attached to packages shipped in the US. The component can also return just the Delivery or Signature Confirmation number (without an associated label), for use if you wish to print your own labels and generate your own barcodes from the returned 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 First-Class Mail parcels, Priority Mail and Package Services (Parcel Post, Bound Printed Matter, Media Mail, and Library Mail), including the date, time, and ZIP Code of delivery, as well as attempted deliveries, forwarding, and returns.

Please note that Delivery and Signature Confirmation services are not available to APO/FPO addresses, foreign countries, or most U.S. territories.

To get the Delivery Confirmation number for a package being shipped, you can call GetDeliveryConfirmationNumber method.

To get the Delivery Confirmation label for a package being shipped, you can call GetDeliveryConfirmationLabel method.

To get the Signature Confirmation number for a package being shipped, you can call GetSignatureConfirmationNumber method.

To get the Signature Confirmation label for a package being shipped, you can call GetSignatureConfirmationLabel method.

You can have the Signature & Delivery Confirmation labels and Customer Online Record returned either together on the same page or separated and printed on two pages. The selection can be made by setting the SeparateReceipt property.

The USPS Server may return either an entire label with the 'To' and 'From' address and the confirmation barcode, or just the barcode and tracking number alone. You can specify the desired option by setting the LabelOption property of this component.

An error message will be returned if an incorrect value is entered. Also, be aware of the maximum character amounts allowed for some properties (these are listed separately under each property description). If you enter more than those amounts, an error will not be generated. The control will simply pass in the characters up to the maximum amount allowed and disregard the rest. This is important since the resulting value could prevent a correct response.

Postage is required on these labels, as well as the Confirmation Services charge (known as the "electronic option rate") for Delivery Confirmation. This discounted "electronic option rate" for Confirmation Services must be added into the total postage amount affixed to these labels (by using stamps, meter strips, or other indicia).

If you wish to provide your customers the tracking number of your Delivery Confirmation package, four optional properties (SenderName, SenderEmail, RecipientName and RecipientEmail) are used to transmit the number via e-mail. This number can be used to track the packages shipped.

Property List

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


AddressServiceRequest	Indicates if an address service request is made.
BarcodeNumber	Postnet Barcode number associated with label's barcode.
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.
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.
FromName	Sender's full name.
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.
LabelOption	Indicates type of label the USPS Server will return.
MailingLocation	Postal Office Zip Code where the item will be mailed (if different from FromZipCode).
Password	Password to use for logging in to the USPS Server.
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.
ServiceType	Mail service type desired.
ShippingLabel	Image of the shipping label retrieved by USPS Server.
ShippingLabelFile	Filename and location to save the ShippingLabel to.
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.
ToName	Recipient's full name.
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.
GetDeliveryConfirmationLabel	Generates a Delivery Confirmation Label for a package being shipped.
GetDeliveryConfirmationNumber	Generates a Delivery Confirmation Number.
GetSignatureConfirmationLabel	Generates a Signature Confirmation Label for a package being shipped.
GetSignatureConfirmationNumber	Generates a Signature Confirmation Number that can be applied to user-generated labels.
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).
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.
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.