USPSMgr Class

Properties Methods Events Configuration Settings Errors

Provides a way to perform account management operations.

Class Name

InShip_USPSMgr

Procedural Interface

 inship_uspsmgr_open();
 inship_uspsmgr_close($res);
 inship_uspsmgr_register_callback($res, $id, $function);
 inship_uspsmgr_get_last_error($res);
 inship_uspsmgr_get_last_error_code($res);
 inship_uspsmgr_set($res, $id, $index, $value);
 inship_uspsmgr_get($res, $id, $index);
 inship_uspsmgr_do_changepassphrase($res, $newpassphrase);
 inship_uspsmgr_do_config($res, $configurationstring);
 inship_uspsmgr_do_getaccountstatus($res);
 inship_uspsmgr_do_recredit($res, $amount);
 inship_uspsmgr_do_refund($res, $id, $idtype);

Remarks

The USPSMgr component provides access to account management functionality for USPS and Endicia. Using the methods and properties exposed here will allow you to programmatically manage accounts. Below is a list of currently supported operations.


Provider	Method	Description
Endicia	Recredit	Used to buy postage.
Endicia	Refund	Request a refund for a shipment.
Endicia	ChangePassPhrase	Change the password for an account.
Endicia	GetAccountStatus	Get the status of an account.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
PostageBalance	Remaining postage balance after re-credit in dollars and cents.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
USPSAccountNumber	The shipper's Endicia account number.
USPSPassword	Password to use for logging in to the USPS Server .
USPSServer	URL for the USPS server where the requests are sent.
USPSUserId	User Id for logging in to the USPS Server .

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


ChangePassPhrase	Change the PassPhrase for an account.
Config	Sets or retrieves a configuration setting .
GetAccountStatus	Retrieves balance and account information.
Recredit	Add postage to an account.
Refund	Submit refund requests for an account.

Event List

The following is the full list of the events fired by the class 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 class with short descriptions. Click on the links for further details.


RawRequest	Contains the complete request sent to USPS.
RawResponse	Contains the complete response returned by the USPS server.
XPath	Used to retrieve data at any place within the response.
RequesterId	The Requester Id to be used for Endicia requests.
AscendingBalance	Total amount of postage printed (after re-credit) in dollars and cents.
SerialNumber	The Serial Number of the last item created on the account.
AccountStatus	The status of the account.
ControlTotal	Stamps.com account control total.
TransactionId	Transaction Id for each credit purchase.
PurchaseStatus	Purchase status for each credit purchase.
IntegratorTxId	Stamps.com transaction integrator Id.
GetPurchaseStatus	Sends a request to get purchase status.
DeviceID	The account's 12 character Device ID (that appears in the indicium).
PostageProvider	The postage provider to use.
TestMode	This configuration setting will allow you to run test transactions using USPSMgr component.
UseEWSService	This configuration setting will allow you to run Refund transactions using Endicia EWS Label Service.
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.