USPSAddress Bean
Properties Methods Events Configuration Settings Errors
Provides address standardization, zip code lookup and city/state lookup.
Syntax
InShip.Uspsaddress
Remarks
This bean allows an authorized user to verify and standardize a customer address, as well as look up zip codes and cities/states. To do this, call the ValidateAddress method with one of the following input combinations:
| Address1, Address2, City, State and ZipCode | This corrects errors in Address1, Address2, City, and State, including abbreviations and missing information. It also supplies the ZipCode for the given address. The address is then considered to be "standardized". |
| City and State | This returns the ZipCode corresponding to the given City, and State. |
| ZipCode | This returns the City and State corresponding to the given ZipCode. |
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
| Address | Identifies the address to be validated. |
| Company | The name of the Firm/Company. |
| Firewall | A set of properties related to firewall access. |
| Matches | Collection of address candidates that meet the search criteria. |
| Notes | Message returned when multiple addresses found. |
| Proxy | A set of properties related to proxy access. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A timeout for the component. |
| USPSAccount | Login information for USPS. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting . |
| reset | Resets the internal state of the component and all properties to their default values. |
| validateAddress | Returns corrected and standardized address information. |
Event List
The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| 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 bean with short descriptions. Click on the links for further details.
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| XPath | Used to retrieve data at any place within the response. |
| AddressMatch | Whether address matches. |
| CityStateZipOK | Whether city, state and zip code is OK. |
| FullName | The recipient's full name. |
| IsPOBox | Whether the address is a PO Box. |
| ResidentialDeliveryIndicator | Whether the address is a business, residential or of unknown type. |
| PostageProvider | The postage provider to use. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if 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 authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| 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. |
| 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). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |