IPWorks S/MIME 2020 PHP Edition

Questions / Feedback?

SNNTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The SNNTP Class is used to read, search, and post articles on Usenet news servers.

Class Name

IPWorksSMIME_SNNTP

Procedural Interface

 ipworkssmime_snntp_open();
 ipworkssmime_snntp_close($res);
 ipworkssmime_snntp_register_callback($res, $id, $function);
 ipworkssmime_snntp_get_last_error($res);
 ipworkssmime_snntp_get_last_error_code($res);
 ipworkssmime_snntp_set($res, $id, $index, $value);
 ipworkssmime_snntp_get($res, $id, $index);
 ipworkssmime_snntp_do_addrecipientcert($res, $certencoded);
 ipworkssmime_snntp_do_config($res, $configurationstring);
 ipworkssmime_snntp_do_connect($res);
 ipworkssmime_snntp_do_decrypt($res);
 ipworkssmime_snntp_do_decryptandverifysignature($res);
 ipworkssmime_snntp_do_disconnect($res);
 ipworkssmime_snntp_do_doevents($res);
 ipworkssmime_snntp_do_encrypt($res);
 ipworkssmime_snntp_do_fetcharticle($res);
 ipworkssmime_snntp_do_fetcharticlebody($res);
 ipworkssmime_snntp_do_fetcharticleheaders($res);
 ipworkssmime_snntp_do_groupoverview($res);
 ipworkssmime_snntp_do_groupsearch($res);
 ipworkssmime_snntp_do_interrupt($res);
 ipworkssmime_snntp_do_listgroups($res);
 ipworkssmime_snntp_do_listnewgroups($res);
 ipworkssmime_snntp_do_localizedate($res, $datetime);
 ipworkssmime_snntp_do_postarticle($res);
 ipworkssmime_snntp_do_reset($res);
 ipworkssmime_snntp_do_resetheaders($res);
 ipworkssmime_snntp_do_sign($res);
 ipworkssmime_snntp_do_signandencrypt($res);
 ipworkssmime_snntp_do_verifysignature($res);

Remarks

The SNNTP Class is the S/MIME enabled equivalent of the IPWorks NNTP class. In addition to standard NNTP functions the SNNTP class can sign, encrypt, decrypt, and verify message signatures. The methods and properties for encrypting, signing, decrypting, and verifying signatures are identical to those provided with the S/MIME class. After setting the certificate properties, and specifying ArticleText, call the Encrypt, Sign or SignAndEncrypt method before posting and the result will be stored in ArticleText. When attempting to verify a signed message or when decrypting a message call the Decrypt, VerifySignature, or DecryptAndVerifySignature methods and the resulting text will be replaced in ArticleText.

The SNNTP Class implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and read and post articles.

The CurrentGroup property sets the current newsgroup. From then on, news articles from that group can be read by setting the article number in CurrentArticle and then calling the appropriate method. Properties such as ArticleCount, FirstArticle, LastArticle provide information about the current state.

The headers and text of the articles are received respectively through the Header and Transfer events. Additionally, up to MaxLines from the article body are provided in the ArticleText property. The GroupOverview event returns information about a range of articles (OverviewRange) in CurrentGroup, and the GroupList event is used when listing newsgroup names. The PITrail event provides a trace of the interaction with the server.

The class supports posting of articles through the ArticleText and AttachedFile properties. The article text is specified in one or both of the above, and then the PostArticle method is called. Article headers are given in a series of properties like ArticleFrom, ArticleSubject, Organization, etc. that map directly to the USENET article header with the same name.

Property List


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

ArticleCountThe estimated number of articles in CurrentGroup .
ArticleDateThe date of the current article.
ArticleFromThe email address of the author (for posting articles).
ArticleHeadersThe full headers of the article as retrieved from the server.
ArticleIdThe message identifier of the current article.
GroupOverviewCountThe number of records in the GroupOverview arrays.
GroupOverviewArticleLinesThe number of lines of an article in a newsgroup overview.
GroupOverviewArticleNumberThe number of an article in a newsgroup overview.
GroupOverviewArticleSizeThe size of an article in a newsgroup overview.
GroupOverviewDateThe date of an article in a newsgroup overview.
GroupOverviewFromThe sender of an article in a newsgroup overview.
GroupOverviewMessageIdThe unique message id of an article in a newsgroup overview.
GroupOverviewOtherHeadersThe remaining headers of an article in a newsgroup overview.
GroupOverviewReferencesThe references of an article in a newsgroup overview.
GroupOverviewSubjectThe subject of an article in a newsgroup overview.
ArticleReferencesArticles to which the posted article follows up.
ArticleReplyToThe address to reply to (for posting articles).
ArticleSubjectThe article subject (for posted articles).
ArticleTextThe full text of the article (without the headers).
AttachedFileA file name which the contents of will be appended to the ArticleText when posting articles.
CertEncodedThe certificate (PEM/base64 encoded).
CertStoreThe name of the certificate store for the client certificate.
CertStorePasswordIf 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.
CertStoreTypeThe type of certificate store for this certificate.
CertSubjectThe subject of the certificate used for client authentication.
CheckDateThe date (format YYMMDD HHMMSS) to check for creation of new groups. If the group was created after the date specified, it is considered new.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the class is connected.
CurrentArticleThe number or message identifier of the current article.
CurrentGroupThe name of the current group.
EncryptingAlgorithmTextual description of the encrypting algorithm.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FirstArticleThe number of the first article in CurrentGroup .
GroupListCountThe number of records in the GroupList arrays.
GroupListCanPostThis property indicates whether a group in a newsgroup listing allows postings or articles.
GroupListFirstArticleThis property shows the first available article in a newsgroup listing.
GroupListGroupThis property shows the group name in a newsgroup listing.
GroupListLastArticleThis property shows the last available article in a newsgroup listing.
IdleThe current status of the class.
IncludeCertificateSpecifies whether to include the signer's certificate with the signed message.
IncludeChainSpecifies whether to include the signer's certificate chain with the signed message.
LastArticleThe number of the last article in CurrentGroup .
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxLinesThe maximum number of message lines aside from headers to retrieve.
NewsgroupsA comma separated list of newsgroups in which to post the article.
NewsPortThe server port for secure NNTP (default 119).
NewsServerThe name or address of a news server.
OrganizationThe organization of the author (for posting articles).
OtherHeadersAn RFC850 compliant string consisting of extra headers (for posting articles).
OverviewRangeA range for the GroupOverview method (first-last).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA logon password for the NewsServer .
RecipientCertCountThe number of records in the RecipientCert arrays.
RecipientCertEncodedThe certificate (PEM/base64 encoded).
RecipientCertStoreThe name of the certificate store for the client certificate.
RecipientCertStorePasswordIf 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.
RecipientCertStoreTypeThe type of certificate store for this certificate.
RecipientCertSubjectThe subject of the certificate used for client authentication.
SearchHeaderA header for the GroupSearch method.
SearchPatternA search pattern for the GroupSearch method.
SearchRangeA range for the GroupSearch method (first-last).
SignerCertEncodedThe certificate (PEM/base64 encoded).
SignerCertIssuerThe issuer of the certificate.
SignerCertSerialNumberThe serial number of the certificate encoded as a string.
SignerCertStoreThe name of the certificate store for the client certificate.
SignerCertStorePasswordIf 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.
SignerCertStoreTypeThe type of certificate store for this certificate.
SignerCertSubjectThe subject of the certificate used for client authentication.
SigningAlgorithmTextual description of the signature hash algorithm.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SSLStartModeDetermines how the class starts the SSL negotiation.
TimeoutA timeout for the class.
UserA user identifier to login as in the NewsServer .

Method List


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

AddRecipientCertUsed to add recipient certificates used to encrypt messages.
ConfigSets or retrieves a configuration setting.
ConnectConnects to the news server.
DecryptDecrypts the current Message .
DecryptAndVerifySignatureDecrypts and verifies the signature of the current message.
DisconnectDisconnects from the news server.
DoEventsProcesses events from the internal message queue.
EncryptEncrypts the message.
FetchArticleGet the headers and body of an article specified in CurrentArticle .
FetchArticleBodyGets only the body of an article specified in CurrentArticle .
FetchArticleHeadersGets only the headers of an article specified in CurrentArticle .
GroupOverviewReceives an overview for the articles in range OverviewRange in the CurrentGroup .
GroupSearchReceives an overview for the articles in range SearchRange in the CurrentGroup .
InterruptInterrupt the current method.
ListGroupsLists all groups on the server.
ListNewGroupsLists all new groups on the server.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
PostArticlePosts the current article and attached file.
ResetReset the class.
ResetHeadersResets all of the article headers.
SignSigns the current message.
SignAndEncryptSigns and encrypts the current message.
VerifySignatureVerifies the signature of the current message.

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.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the article text completes transferring.
ErrorInformation about errors during data delivery.
GroupListFired while group data transfers (during group listings).
GroupOverviewFired for each line of article overview data (during group overviews).
GroupSearchFired for each line of group search data (during group searches).
HeaderFired for every article header being retrieved during article retrieval.
PITrailTraces the commands sent to the news server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the article text starts transferring.
TransferFired while the article text gets transferred (to or from the NewsServer ).

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

ArticleInfoLimitInstructs class to save the amount of articles specified that are returned by the server when a GroupOverview event is fired.
GroupInfoLimitInstructs class to save the amount of group info objects specified that are returned by the server after a ListGroups call has been made.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 PHP Edition - Version 20.0 [Build 7721]