SNNTP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SNNTP

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 to 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, and LastArticle, provide information about the current state.

The headers and text of the articles are received through the Header and Transfer events, respectively. 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, such as ArticleFrom, ArticleSubject, and Organization, 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.

Method List

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

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.

Config Settings

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

ArticleCount Property (SNNTP Class)

This property includes the estimated number of articles in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetArticleCount();

Unicode (Windows)
LONG64 GetArticleCount();

int64 ipworkssmime_snntp_getarticlecount(void* lpObj);

qint64 GetArticleCount();

Default Value

0

Remarks

This property contains the estimated number of articles in CurrentGroup. The value of this property is 0 if there is no current group (CurrentGroup is ""). Otherwise, when CurrentGroup is set, it is the number of articles in the group as shown by the news server. For most news servers, this is an estimated value of the number of the articles, rather than the exact value.

This property is read-only.

Data Type

Long64

ArticleDate Property (SNNTP Class)

This property includes the date of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleDate();

Unicode (Windows)
LPWSTR GetArticleDate();

char* ipworkssmime_snntp_getarticledate(void* lpObj);

QString GetArticleDate();

Default Value

""

Remarks

This property contains the date of the current article. If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the date of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleFrom Property (SNNTP Class)

This property includes the email address of the author (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleFrom();
int SetArticleFrom(const char* lpszArticleFrom);

Unicode (Windows)
LPWSTR GetArticleFrom();
INT SetArticleFrom(LPCWSTR lpszArticleFrom);

char* ipworkssmime_snntp_getarticlefrom(void* lpObj);
int ipworkssmime_snntp_setarticlefrom(void* lpObj, const char* lpszArticleFrom);

QString GetArticleFrom();
int SetArticleFrom(QString qsArticleFrom);

Default Value

""

Remarks

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleHeaders Property (SNNTP Class)

This property includes the full headers of the article as retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleHeaders();

Unicode (Windows)
LPWSTR GetArticleHeaders();

char* ipworkssmime_snntp_getarticleheaders(void* lpObj);

QString GetArticleHeaders();

Default Value

""

Remarks

This property contains the full headers of the article as retrieved from the server. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full headers of the article as reported by the server.

The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleId Property (SNNTP Class)

This property includes the message identifier of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleId();

Unicode (Windows)
LPWSTR GetArticleId();

char* ipworkssmime_snntp_getarticleid(void* lpObj);

QString GetArticleId();

Default Value

""

Remarks

This property contains the message identifier of the current article. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the message identifier of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If the CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

GroupOverviewCount Property (SNNTP Class)

The number of records in the GroupOverview arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupOverviewCount();

Unicode (Windows)
INT GetGroupOverviewCount();

int ipworkssmime_snntp_getgroupoverviewcount(void* lpObj);

int GetGroupOverviewCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• GroupOverviewArticleLines
• GroupOverviewArticleNumber
• GroupOverviewArticleSize
• GroupOverviewDate
• GroupOverviewFrom
• GroupOverviewMessageId
• GroupOverviewOtherHeaders
• GroupOverviewReferences
• GroupOverviewSubject

The array indices start at 0 and end at GroupOverviewCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

GroupOverviewArticleLines Property (SNNTP Class)

This is the number of lines of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleLines(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleLines(INT iGroupOverviewIndex);

int64 ipworkssmime_snntp_getgroupoverviewarticlelines(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleLines(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the number of lines of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

Long64

GroupOverviewArticleNumber Property (SNNTP Class)

This is the number of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleNumber(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleNumber(INT iGroupOverviewIndex);

int64 ipworkssmime_snntp_getgroupoverviewarticlenumber(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleNumber(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the number of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

Long64

GroupOverviewArticleSize Property (SNNTP Class)

This is the size of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleSize(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleSize(INT iGroupOverviewIndex);

int64 ipworkssmime_snntp_getgroupoverviewarticlesize(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleSize(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the size of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

Long64

GroupOverviewDate Property (SNNTP Class)

This is the date of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewDate(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewDate(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewdate(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewDate(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the date of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

GroupOverviewFrom Property (SNNTP Class)

This is the sender of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewFrom(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewFrom(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewfrom(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewFrom(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the sender of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

GroupOverviewMessageId Property (SNNTP Class)

This is the unique message Id of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewMessageId(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewMessageId(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewmessageid(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewMessageId(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the unique message Id of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

GroupOverviewOtherHeaders Property (SNNTP Class)

This is the remaining headers of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewOtherHeaders(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewOtherHeaders(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewotherheaders(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewOtherHeaders(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the remaining headers of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

GroupOverviewReferences Property (SNNTP Class)

This is the references of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewReferences(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewReferences(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewreferences(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewReferences(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the references of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

GroupOverviewSubject Property (SNNTP Class)

This is the subject of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewSubject(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewSubject(INT iGroupOverviewIndex);

char* ipworkssmime_snntp_getgroupoverviewsubject(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewSubject(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the subject of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

This property is read-only and not available at design time.

Data Type

String

ArticleReferences Property (SNNTP Class)

This property includes articles to which the posted article follows up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleReferences();
int SetArticleReferences(const char* lpszArticleReferences);

Unicode (Windows)
LPWSTR GetArticleReferences();
INT SetArticleReferences(LPCWSTR lpszArticleReferences);

char* ipworkssmime_snntp_getarticlereferences(void* lpObj);
int ipworkssmime_snntp_setarticlereferences(void* lpObj, const char* lpszArticleReferences);

QString GetArticleReferences();
int SetArticleReferences(QString qsArticleReferences);

Default Value

""

Remarks

This property contains articles to which the posted article follows up. If this property contains a nonempty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleReplyTo Property (SNNTP Class)

This property includes the address to reply to (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleReplyTo();
int SetArticleReplyTo(const char* lpszArticleReplyTo);

Unicode (Windows)
LPWSTR GetArticleReplyTo();
INT SetArticleReplyTo(LPCWSTR lpszArticleReplyTo);

char* ipworkssmime_snntp_getarticlereplyto(void* lpObj);
int ipworkssmime_snntp_setarticlereplyto(void* lpObj, const char* lpszArticleReplyTo);

QString GetArticleReplyTo();
int SetArticleReplyTo(QString qsArticleReplyTo);

Default Value

""

Remarks

This property contains the address to reply to (for posting articles). If this property contains a nonempty string, a Reply-To article header is created for the article. This header shows the address to use for replies, which is useful if this address is different from the one in ArticleFrom.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleSubject Property (SNNTP Class)

This property includes the article subject (for posted articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleSubject();
int SetArticleSubject(const char* lpszArticleSubject);

Unicode (Windows)
LPWSTR GetArticleSubject();
INT SetArticleSubject(LPCWSTR lpszArticleSubject);

char* ipworkssmime_snntp_getarticlesubject(void* lpObj);
int ipworkssmime_snntp_setarticlesubject(void* lpObj, const char* lpszArticleSubject);

QString GetArticleSubject();
int SetArticleSubject(QString qsArticleSubject);

Default Value

""

Remarks

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleText Property (SNNTP Class)

This property includes the full text of the article (without the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleText();
int SetArticleText(const char* lpszArticleText);

Unicode (Windows)
LPWSTR GetArticleText();
INT SetArticleText(LPCWSTR lpszArticleText);

char* ipworkssmime_snntp_getarticletext(void* lpObj);
int ipworkssmime_snntp_setarticletext(void* lpObj, const char* lpszArticleText);

QString GetArticleText();
int SetArticleText(QString qsArticleText);

Default Value

""

Remarks

This property contains the full text of the article (without the headers). If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The NewsServer is asked about the text of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

AttachedFile Property (SNNTP Class)

This property includes a filename for which the contents will be appended to the ArticleText when posting articles.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFile();
int SetAttachedFile(const char* lpszAttachedFile);

Unicode (Windows)
LPWSTR GetAttachedFile();
INT SetAttachedFile(LPCWSTR lpszAttachedFile);

char* ipworkssmime_snntp_getattachedfile(void* lpObj);
int ipworkssmime_snntp_setattachedfile(void* lpObj, const char* lpszAttachedFile);

QString GetAttachedFile();
int SetAttachedFile(QString qsAttachedFile);

Default Value

""

Remarks

The content of this property is appended to the text in ArticleText (if any) and sent to the news server. This property is useful for posting arbitrarily large articles or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain only 7-bit characters so that the message may be sent successfully through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

CertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworkssmime_snntp_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworkssmime_snntp_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

CertStore Property (SNNTP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore);

Unicode (Windows)
INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);

int ipworkssmime_snntp_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworkssmime_snntp_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

CertStorePassword Property (SNNTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword);

Unicode (Windows)
LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);

char* ipworkssmime_snntp_getcertstorepassword(void* lpObj);
int ipworkssmime_snntp_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (SNNTP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Unicode (Windows)
INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworkssmime_snntp_getcertstoretype(void* lpObj);
int ipworkssmime_snntp_setcertstoretype(void* lpObj, int iCertStoreType);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubject Property (SNNTP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject);

Unicode (Windows)
LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);

char* ipworkssmime_snntp_getcertsubject(void* lpObj);
int ipworkssmime_snntp_setcertsubject(void* lpObj, const char* lpszCertSubject);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

CheckDate Property (SNNTP Class)

This property includes the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckDate();
int SetCheckDate(const char* lpszCheckDate);

Unicode (Windows)
LPWSTR GetCheckDate();
INT SetCheckDate(LPCWSTR lpszCheckDate);

char* ipworkssmime_snntp_getcheckdate(void* lpObj);
int ipworkssmime_snntp_setcheckdate(void* lpObj, const char* lpszCheckDate);

QString GetCheckDate();
int SetCheckDate(QString qsCheckDate);

Default Value

"000101 000000"

Remarks

This property contains the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the ListNewGroups method.

This property is not available at design time.

Data Type

String

Command Property (SNNTP Class)

This property is used to send additional commands directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCommand(const char* lpszCommand);

Unicode (Windows)
INT SetCommand(LPCWSTR lpszCommand);

int ipworkssmime_snntp_setcommand(void* lpObj, const char* lpszCommand);

int SetCommand(QString qsCommand);

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

This property is write-only and not available at design time.

Data Type

String

Connected Property (SNNTP Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworkssmime_snntp_getconnected(void* lpObj);
int ipworkssmime_snntp_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CurrentArticle Property (SNNTP Class)

This property includes the number or message identifier of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrentArticle();
int SetCurrentArticle(const char* lpszCurrentArticle);

Unicode (Windows)
LPWSTR GetCurrentArticle();
INT SetCurrentArticle(LPCWSTR lpszCurrentArticle);

char* ipworkssmime_snntp_getcurrentarticle(void* lpObj);
int ipworkssmime_snntp_setcurrentarticle(void* lpObj, const char* lpszCurrentArticle);

QString GetCurrentArticle();
int SetCurrentArticle(QString qsCurrentArticle);

Default Value

""

Remarks

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as FetchArticle.

Data Type

String

CurrentGroup Property (SNNTP Class)

This property includes the name of the current group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrentGroup();
int SetCurrentGroup(const char* lpszCurrentGroup);

Unicode (Windows)
LPWSTR GetCurrentGroup();
INT SetCurrentGroup(LPCWSTR lpszCurrentGroup);

char* ipworkssmime_snntp_getcurrentgroup(void* lpObj);
int ipworkssmime_snntp_setcurrentgroup(void* lpObj, const char* lpszCurrentGroup);

QString GetCurrentGroup();
int SetCurrentGroup(QString qsCurrentGroup);

Default Value

""

Remarks

This property contains the name of the current group. When this property is set to a valid group name, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group. This property is then used for all references to articles (until it is changed to another group).

Note: It is recommended to use the ChangeCurrentGroup method instead of setting this property.

Data Type

String

EncryptingAlgorithm Property (SNNTP Class)

The property includes textual description of the encrypting algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);

char* ipworkssmime_snntp_getencryptingalgorithm(void* lpObj);
int ipworkssmime_snntp_setencryptingalgorithm(void* lpObj, const char* lpszEncryptingAlgorithm);

QString GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(QString qsEncryptingAlgorithm);

Default Value

"3DES"

Remarks

This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.

Possible values are as follows:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

Data Type

String

FirewallAutoDetect Property (SNNTP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworkssmime_snntp_getfirewallautodetect(void* lpObj);
int ipworkssmime_snntp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SNNTP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworkssmime_snntp_getfirewalltype(void* lpObj);
int ipworkssmime_snntp_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SNNTP Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworkssmime_snntp_getfirewallhost(void* lpObj);
int ipworkssmime_snntp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (SNNTP Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworkssmime_snntp_getfirewallpassword(void* lpObj);
int ipworkssmime_snntp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (SNNTP Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworkssmime_snntp_getfirewallport(void* lpObj);
int ipworkssmime_snntp_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SNNTP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworkssmime_snntp_getfirewalluser(void* lpObj);
int ipworkssmime_snntp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirstArticle Property (SNNTP Class)

This property includes the number of the first article in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetFirstArticle();

Unicode (Windows)
LONG64 GetFirstArticle();

int64 ipworkssmime_snntp_getfirstarticle(void* lpObj);

qint64 GetFirstArticle();

Default Value

0

Remarks

This property contains the number of the first article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

GroupListCount Property (SNNTP Class)

The number of records in the GroupList arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupListCount();

Unicode (Windows)
INT GetGroupListCount();

int ipworkssmime_snntp_getgrouplistcount(void* lpObj);

int GetGroupListCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• GroupListCanPost
• GroupListFirstArticle
• GroupListGroup
• GroupListLastArticle

The array indices start at 0 and end at GroupListCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

GroupListCanPost Property (SNNTP Class)

This property indicates whether a group in a newsgroup listing allows postings or articles.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupListCanPost(int iGroupListIndex);

Unicode (Windows)
BOOL GetGroupListCanPost(INT iGroupListIndex);

int ipworkssmime_snntp_getgrouplistcanpost(void* lpObj, int grouplistindex);

bool GetGroupListCanPost(int iGroupListIndex);

Default Value

FALSE

Remarks

This property indicates whether a group in a newsgroup listing allows postings or articles.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

This property is read-only and not available at design time.

Data Type

Boolean

GroupListFirstArticle Property (SNNTP Class)

This property shows the first available article in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupListFirstArticle(int iGroupListIndex);

Unicode (Windows)
LONG64 GetGroupListFirstArticle(INT iGroupListIndex);

int64 ipworkssmime_snntp_getgrouplistfirstarticle(void* lpObj, int grouplistindex);

qint64 GetGroupListFirstArticle(int iGroupListIndex);

Default Value

0

Remarks

This property shows the first available article in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

This property is read-only and not available at design time.

Data Type

Long64

GroupListGroup Property (SNNTP Class)

This property shows the group name in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupListGroup(int iGroupListIndex);

Unicode (Windows)
LPWSTR GetGroupListGroup(INT iGroupListIndex);

char* ipworkssmime_snntp_getgrouplistgroup(void* lpObj, int grouplistindex);

QString GetGroupListGroup(int iGroupListIndex);

Default Value

""

Remarks

This property shows the group name in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

This property is read-only and not available at design time.

Data Type

String

GroupListLastArticle Property (SNNTP Class)

This property shows the last available article in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupListLastArticle(int iGroupListIndex);

Unicode (Windows)
LONG64 GetGroupListLastArticle(INT iGroupListIndex);

int64 ipworkssmime_snntp_getgrouplistlastarticle(void* lpObj, int grouplistindex);

qint64 GetGroupListLastArticle(int iGroupListIndex);

Default Value

0

Remarks

This property shows the last available article in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

This property is read-only and not available at design time.

Data Type

Long64

Idle Property (SNNTP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworkssmime_snntp_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IncludeCertificate Property (SNNTP Class)

This property specifies whether to include the signer's certificate with the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeCertificate();
int SetIncludeCertificate(int bIncludeCertificate);

Unicode (Windows)
BOOL GetIncludeCertificate();
INT SetIncludeCertificate(BOOL bIncludeCertificate);

int ipworkssmime_snntp_getincludecertificate(void* lpObj);
int ipworkssmime_snntp_setincludecertificate(void* lpObj, int bIncludeCertificate);

bool GetIncludeCertificate();
int SetIncludeCertificate(bool bIncludeCertificate);

Default Value

TRUE

Remarks

If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling Sign or SignAndEncrypt.

Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.

Data Type

Boolean

IncludeChain Property (SNNTP Class)

This property specifies whether to include the signer's certificate chain with the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeChain();
int SetIncludeChain(int bIncludeChain);

Unicode (Windows)
BOOL GetIncludeChain();
INT SetIncludeChain(BOOL bIncludeChain);

int ipworkssmime_snntp_getincludechain(void* lpObj);
int ipworkssmime_snntp_setincludechain(void* lpObj, int bIncludeChain);

bool GetIncludeChain();
int SetIncludeChain(bool bIncludeChain);

Default Value

FALSE

Remarks

If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling Sign or SignAndEncrypt.

Note: To include the chain, the IncludeCertificate property must also be set to true.

Data Type

Boolean

LastArticle Property (SNNTP Class)

This property includes the number of the last article in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetLastArticle();

Unicode (Windows)
LONG64 GetLastArticle();

int64 ipworkssmime_snntp_getlastarticle(void* lpObj);

qint64 GetLastArticle();

Default Value

0

Remarks

This property contains the number of the last article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

LastReply Property (SNNTP Class)

The last reply from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworkssmime_snntp_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalHost Property (SNNTP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworkssmime_snntp_getlocalhost(void* lpObj);
int ipworkssmime_snntp_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MaxLines Property (SNNTP Class)

This property includes the maximum number of message lines aside from headers to retrieve.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMaxLines();
int SetMaxLines(int64 lMaxLines);

Unicode (Windows)
LONG64 GetMaxLines();
INT SetMaxLines(LONG64 lMaxLines);

int64 ipworkssmime_snntp_getmaxlines(void* lpObj);
int ipworkssmime_snntp_setmaxlines(void* lpObj, int64 lMaxLines);

qint64 GetMaxLines();
int SetMaxLines(qint64 lMaxLines);

Default Value

0

Remarks

This property is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property.

Note: Because of the Network News Transfer Protocol (NNTP) limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText.

The default value of the property is zero. In this case, the entire message will be retrieved, without interruptions.

This property is not available at design time.

Data Type

Long64

Newsgroups Property (SNNTP Class)

This property includes a comma-separated list of newsgroups in which to post the article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNewsgroups();
int SetNewsgroups(const char* lpszNewsgroups);

Unicode (Windows)
LPWSTR GetNewsgroups();
INT SetNewsgroups(LPCWSTR lpszNewsgroups);

char* ipworkssmime_snntp_getnewsgroups(void* lpObj);
int ipworkssmime_snntp_setnewsgroups(void* lpObj, const char* lpszNewsgroups);

QString GetNewsgroups();
int SetNewsgroups(QString qsNewsgroups);

Default Value

""

Remarks

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the CurrentGroup property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

NewsPort Property (SNNTP Class)

This property includes the server port for the secure Network News Transfer Protocol (NNTP) (default 119).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNewsPort();
int SetNewsPort(int iNewsPort);

Unicode (Windows)
INT GetNewsPort();
INT SetNewsPort(INT iNewsPort);

int ipworkssmime_snntp_getnewsport(void* lpObj);
int ipworkssmime_snntp_setnewsport(void* lpObj, int iNewsPort);

int GetNewsPort();
int SetNewsPort(int iNewsPort);

Default Value

119

Remarks

For implicit Secure Sockets Layer (SSL), use port 563 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

NewsServer Property (SNNTP Class)

This property includes the name or address of a news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNewsServer();
int SetNewsServer(const char* lpszNewsServer);

Unicode (Windows)
LPWSTR GetNewsServer();
INT SetNewsServer(LPCWSTR lpszNewsServer);

char* ipworkssmime_snntp_getnewsserver(void* lpObj);
int ipworkssmime_snntp_setnewsserver(void* lpObj, const char* lpszNewsServer);

QString GetNewsServer();
int SetNewsServer(QString qsNewsServer);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name for the news server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

Organization Property (SNNTP Class)

This property includes the organization of the author (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrganization();
int SetOrganization(const char* lpszOrganization);

Unicode (Windows)
LPWSTR GetOrganization();
INT SetOrganization(LPCWSTR lpszOrganization);

char* ipworkssmime_snntp_getorganization(void* lpObj);
int ipworkssmime_snntp_setorganization(void* lpObj, const char* lpszOrganization);

QString GetOrganization();
int SetOrganization(QString qsOrganization);

Default Value

""

Remarks

This property contains the organization of the article's author. If this property contains a nonempty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

OtherHeaders Property (SNNTP Class)

This property includes an RFC 850-compliant string consisting of extra headers (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworkssmime_snntp_getotherheaders(void* lpObj);
int ipworkssmime_snntp_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like From and Subject.

The headers must be of the format "header: value" as specified in RFC 850. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the class. A good example is posting of MIME attachments.

Special Case: If this property starts with an empty line (e.g., carriage return line feed, CRLF), then the value of this property is used instead of the normally computed article headers.

This property is not available at design time.

Data Type

String

OverviewRange Property (SNNTP Class)

This property includes the range for the GroupOverview method (first-last).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOverviewRange();
int SetOverviewRange(const char* lpszOverviewRange);

Unicode (Windows)
LPWSTR GetOverviewRange();
INT SetOverviewRange(LPCWSTR lpszOverviewRange);

char* ipworkssmime_snntp_getoverviewrange(void* lpObj);
int ipworkssmime_snntp_setoverviewrange(void* lpObj, const char* lpszOverviewRange);

QString GetOverviewRange();
int SetOverviewRange(QString qsOverviewRange);

Default Value

"-"

Remarks

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end.

The default value of this property is '-', meaning 'all articles in the group'.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (SNNTP Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworkssmime_snntp_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (SNNTP Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* ipworkssmime_snntp_getparsedheaderfield(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (SNNTP Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

char* ipworkssmime_snntp_getparsedheadervalue(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

Password Property (SNNTP Class)

This property includes the logon password for the NewsServer .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworkssmime_snntp_getpassword(void* lpObj);
int ipworkssmime_snntp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains a logon password for the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent to provide authentication information for the user. This command is not part of the Network News Transfer Protocol (NNTP), but it is widely used by popular news servers.

Data Type

String

RecipientCertCount Property (SNNTP Class)

The number of records in the RecipientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

Unicode (Windows)
INT GetRecipientCertCount();
INT SetRecipientCertCount(INT iRecipientCertCount);

int ipworkssmime_snntp_getrecipientcertcount(void* lpObj);
int ipworkssmime_snntp_setrecipientcertcount(void* lpObj, int iRecipientCertCount);

int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject

The array indices start at 0 and end at RecipientCertCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientCertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertEncoded(int iRecipientCertIndex, char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(int iRecipientCertIndex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

Unicode (Windows)
INT GetRecipientCertEncoded(INT iRecipientCertIndex, LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(INT iRecipientCertIndex, LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);

int ipworkssmime_snntp_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworkssmime_snntp_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

QByteArray GetRecipientCertEncoded(int iRecipientCertIndex);
int SetRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (SNNTP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStore(int iRecipientCertIndex, char* &lpRecipientCertStore, int &lenRecipientCertStore);
int SetRecipientCertStore(int iRecipientCertIndex, const char* lpRecipientCertStore, int lenRecipientCertStore);

Unicode (Windows)
INT GetRecipientCertStore(INT iRecipientCertIndex, LPSTR &lpRecipientCertStore, INT &lenRecipientCertStore);
INT SetRecipientCertStore(INT iRecipientCertIndex, LPCSTR lpRecipientCertStore, INT lenRecipientCertStore);

int ipworkssmime_snntp_getrecipientcertstore(void* lpObj, int recipientcertindex, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworkssmime_snntp_setrecipientcertstore(void* lpObj, int recipientcertindex, const char* lpRecipientCertStore, int lenRecipientCertStore);

QByteArray GetRecipientCertStore(int iRecipientCertIndex);
int SetRecipientCertStore(int iRecipientCertIndex, QByteArray qbaRecipientCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (SNNTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, const char* lpszRecipientCertStorePassword);

Unicode (Windows)
LPWSTR GetRecipientCertStorePassword(INT iRecipientCertIndex);
INT SetRecipientCertStorePassword(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertStorePassword);

char* ipworkssmime_snntp_getrecipientcertstorepassword(void* lpObj, int recipientcertindex);
int ipworkssmime_snntp_setrecipientcertstorepassword(void* lpObj, int recipientcertindex, const char* lpszRecipientCertStorePassword);

QString GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, QString qsRecipientCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (SNNTP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);

Unicode (Windows)
INT GetRecipientCertStoreType(INT iRecipientCertIndex);
INT SetRecipientCertStoreType(INT iRecipientCertIndex, INT iRecipientCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworkssmime_snntp_getrecipientcertstoretype(void* lpObj, int recipientcertindex);
int ipworkssmime_snntp_setrecipientcertstoretype(void* lpObj, int recipientcertindex, int iRecipientCertStoreType);

int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (SNNTP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, const char* lpszRecipientCertSubject);

Unicode (Windows)
LPWSTR GetRecipientCertSubject(INT iRecipientCertIndex);
INT SetRecipientCertSubject(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertSubject);

char* ipworkssmime_snntp_getrecipientcertsubject(void* lpObj, int recipientcertindex);
int ipworkssmime_snntp_setrecipientcertsubject(void* lpObj, int recipientcertindex, const char* lpszRecipientCertSubject);

QString GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, QString qsRecipientCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

SearchHeader Property (SNNTP Class)

This property includes a header for the GroupSearch method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchHeader();
int SetSearchHeader(const char* lpszSearchHeader);

Unicode (Windows)
LPWSTR GetSearchHeader();
INT SetSearchHeader(LPCWSTR lpszSearchHeader);

char* ipworkssmime_snntp_getsearchheader(void* lpObj);
int ipworkssmime_snntp_setsearchheader(void* lpObj, const char* lpszSearchHeader);

QString GetSearchHeader();
int SetSearchHeader(QString qsSearchHeader);

Default Value

""

Remarks

This property specifies the header to search for SearchPattern (e.g., Subject).

This property is not available at design time.

Data Type

String

SearchPattern Property (SNNTP Class)

This property includes a search pattern for the GroupSearch method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchPattern();
int SetSearchPattern(const char* lpszSearchPattern);

Unicode (Windows)
LPWSTR GetSearchPattern();
INT SetSearchPattern(LPCWSTR lpszSearchPattern);

char* ipworkssmime_snntp_getsearchpattern(void* lpObj);
int ipworkssmime_snntp_setsearchpattern(void* lpObj, const char* lpszSearchPattern);

QString GetSearchPattern();
int SetSearchPattern(QString qsSearchPattern);

Default Value

""

Remarks

This property contains a search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX Find command.

As an example, "* new *" will match all headers that contain the word "new".

This property is not available at design time.

Data Type

String

SearchRange Property (SNNTP Class)

This property includes the range for the GroupSearch method (first-last).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchRange();
int SetSearchRange(const char* lpszSearchRange);

Unicode (Windows)
LPWSTR GetSearchRange();
INT SetSearchRange(LPCWSTR lpszSearchRange);

char* ipworkssmime_snntp_getsearchrange(void* lpObj);
int ipworkssmime_snntp_setsearchrange(void* lpObj, const char* lpszSearchRange);

QString GetSearchRange();
int SetSearchRange(QString qsSearchRange);

Default Value

"-"

Remarks

This property specifies a range of articles for which to do a search on the server. The format is First-Last where First is "" (empty string) or a positive number, and Last is "" (empty string), a positive number, or the token End.

The default value of the property is "-", meaning "search all articles in the group".

This property is not available at design time.

Data Type

String

SignerCertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded);

Unicode (Windows)
INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);

int ipworkssmime_snntp_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworkssmime_snntp_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SignerCertIssuer Property (SNNTP Class)

This is the issuer of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertIssuer();

Unicode (Windows)
LPWSTR GetSignerCertIssuer();

char* ipworkssmime_snntp_getsignercertissuer(void* lpObj);

QString GetSignerCertIssuer();

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SignerCertSerialNumber Property (SNNTP Class)

This is the serial number of the certificate encoded as a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSerialNumber();

Unicode (Windows)
LPWSTR GetSignerCertSerialNumber();

char* ipworkssmime_snntp_getsignercertserialnumber(void* lpObj);

QString GetSignerCertSerialNumber();

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SignerCertStore Property (SNNTP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore);

Unicode (Windows)
INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);

int ipworkssmime_snntp_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworkssmime_snntp_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SignerCertStorePassword Property (SNNTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);

char* ipworkssmime_snntp_getsignercertstorepassword(void* lpObj);
int ipworkssmime_snntp_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (SNNTP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Unicode (Windows)
INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworkssmime_snntp_getsignercertstoretype(void* lpObj);
int ipworkssmime_snntp_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubject Property (SNNTP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject);

Unicode (Windows)
LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);

char* ipworkssmime_snntp_getsignercertsubject(void* lpObj);
int ipworkssmime_snntp_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SigningAlgorithm Property (SNNTP Class)

This property includes a textual description of the signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm);

Unicode (Windows)
LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);

char* ipworkssmime_snntp_getsigningalgorithm(void* lpObj);
int ipworkssmime_snntp_setsigningalgorithm(void* lpObj, const char* lpszSigningAlgorithm);

QString GetSigningAlgorithm();
int SetSigningAlgorithm(QString qsSigningAlgorithm);

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

Data Type

String

SSLAcceptServerCertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworkssmime_snntp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssmime_snntp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworkssmime_snntp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssmime_snntp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SNNTP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworkssmime_snntp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssmime_snntp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (SNNTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworkssmime_snntp_getsslcertstorepassword(void* lpObj);
int ipworkssmime_snntp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SNNTP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworkssmime_snntp_getsslcertstoretype(void* lpObj);
int ipworkssmime_snntp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (SNNTP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworkssmime_snntp_getsslcertsubject(void* lpObj);
int ipworkssmime_snntp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLEnabled Property (SNNTP Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworkssmime_snntp_getsslenabled(void* lpObj);
int ipworkssmime_snntp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (SNNTP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworkssmime_snntp_getsslprovider(void* lpObj);
int ipworkssmime_snntp_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (SNNTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworkssmime_snntp_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SSLStartMode Property (SNNTP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworkssmime_snntp_getsslstartmode(void* lpObj);
int ipworkssmime_snntp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (SNNTP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworkssmime_snntp_gettimeout(void* lpObj);
int ipworkssmime_snntp_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (SNNTP Class)

This property includes a user identifier to login as in the NewsServer .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworkssmime_snntp_getuser(void* lpObj);
int ipworkssmime_snntp_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property contains a user identifier to login as in the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO USER command is sent to provide authentication information for the user. Although this command is not part of the Network News Transfer Protocol (NNTP), it is widely used by news servers for authentication purposes.

Data Type

String

AddRecipientCert Method (SNNTP Class)

This method is used to add recipient certificates used to encrypt messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRecipientCert(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT AddRecipientCert(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworkssmime_snntp_addrecipientcert(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

int AddRecipientCert(QByteArray qbaCertEncoded);

Remarks

This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangeCurrentGroup Method (SNNTP Class)

This method changes the current group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeCurrentGroup(const char* lpszGroup);

Unicode (Windows)
INT ChangeCurrentGroup(LPCWSTR lpszGroup);

int ipworkssmime_snntp_changecurrentgroup(void* lpObj, const char* lpszGroup);

int ChangeCurrentGroup(const QString& qsGroup);

Remarks

This method changes the current group. When calling this method, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SNNTP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssmime_snntp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (SNNTP Class)

This method connects to the news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworkssmime_snntp_connect(void* lpObj);

int Connect();

Remarks

This method is used to connect to the news server. If the User and/or Password are set, then corresponding AUTHINFO commands are sent to the NewsServer as well.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Decrypt Method (SNNTP Class)

This method decrypts the current Message .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworkssmime_snntp_decrypt(void* lpObj);

int Decrypt();

Remarks

This method attempts to decrypt the encrypted message using the certificate in Certificate.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecryptAndVerifySignature Method (SNNTP Class)

This method decrypts and verifies the signature of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();

int ipworkssmime_snntp_decryptandverifysignature(void* lpObj);

int DecryptAndVerifySignature();

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

Note: This function does not attempt to check the validity of the signing certificate.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (SNNTP Class)

This method disconnects from the news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworkssmime_snntp_disconnect(void* lpObj);

int Disconnect();

Remarks

This method is used to disconnect from the NewsServer. The class first attempts to send a QUIT command, and if that fails, the connection is broken.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SNNTP Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssmime_snntp_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Encrypt Method (SNNTP Class)

This method encrypts the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworkssmime_snntp_encrypt(void* lpObj);

int Encrypt();

Remarks

This method encrypts the input message in a Public Key Cryptography Standards (PKCS)-encoded envelope with all of the recipient certificates specified in the MessageRecipients properties.

Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

FetchArticle Method (SNNTP Class)

This method gets the headers and body of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticle();

Unicode (Windows)
INT FetchArticle();

int ipworkssmime_snntp_fetcharticle(void* lpObj);

int FetchArticle();

Remarks

This method gets the headers and body of the article specified in CurrentArticle. The headers are delivered through the Header event, and the article body is delivered through the Transfer event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

FetchArticleBody Method (SNNTP Class)

This method gets only the body of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticleBody();

Unicode (Windows)
INT FetchArticleBody();

int ipworkssmime_snntp_fetcharticlebody(void* lpObj);

int FetchArticleBody();

Remarks

This method gets only the body of the article specified in CurrentArticle. The body is delivered through the Transfer event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

FetchArticleHeaders Method (SNNTP Class)

This method gets only the headers of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticleHeaders();

Unicode (Windows)
INT FetchArticleHeaders();

int ipworkssmime_snntp_fetcharticleheaders(void* lpObj);

int FetchArticleHeaders();

Remarks

This method gets only the headers of the article specified in CurrentArticle. The headers are delivered through the Header event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GroupOverview Method (SNNTP Class)

This method receives an overview for the articles in range OverviewRange in the CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GroupOverview();

Unicode (Windows)
INT GroupOverview();

int ipworkssmime_snntp_groupoverview(void* lpObj);

int GroupOverview();

Remarks

This method receives an overview for the articles in range OverviewRange in the CurrentGroup. The overview data are delivered through the GroupOverview event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GroupSearch Method (SNNTP Class)

This method receives an overview for the articles in the range SearchRange in the CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GroupSearch();

Unicode (Windows)
INT GroupSearch();

int ipworkssmime_snntp_groupsearch(void* lpObj);

int GroupSearch();

Remarks

This method searches the current newsgroup for articles in the range SearchRange in the CurrentGroup, where SearchHeader matches SearchPattern. The results are delivered through the GroupSearch event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (SNNTP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworkssmime_snntp_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListGroups Method (SNNTP Class)

This method lists all newsgroups on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListGroups();

Unicode (Windows)
INT ListGroups();

int ipworkssmime_snntp_listgroups(void* lpObj);

int ListGroups();

Remarks

This method asks the server to list all of its newsgroups. Use this method with caution as listing groups may take quite a long time over slow links. The group names and other information are returned via the GroupList event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListNewGroups Method (SNNTP Class)

This method lists all newgroups on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListNewGroups();

Unicode (Windows)
INT ListNewGroups();

int ipworkssmime_snntp_listnewgroups(void* lpObj);

int ListNewGroups();

Remarks

This method asks the server to list all of the newsgroups created since CheckDate. The group names (if any) and other information are returned via the GroupList event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LocalizeDate Method (SNNTP Class)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* LocalizeDate(const char* lpszDateTime);

Unicode (Windows)
LPWSTR LocalizeDate(LPCWSTR lpszDateTime);

char* ipworkssmime_snntp_localizedate(void* lpObj, const char* lpszDateTime);

QString LocalizeDate(const QString& qsDateTime);

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PostArticle Method (SNNTP Class)

This method posts the current article and attached file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PostArticle();

Unicode (Windows)
INT PostArticle();

int ipworkssmime_snntp_postarticle(void* lpObj);

int PostArticle();

Remarks

This method posts the current article and attached file (if any). If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SNNTP Class)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssmime_snntp_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResetHeaders Method (SNNTP Class)

This method resets all of the article headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int ipworkssmime_snntp_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

This method resets all the article headers to "" (empty string). Use this method before posting a new article, so that headers from the previous article are not carried over to the next one.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (SNNTP Class)

Sends the exact command directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

int ipworkssmime_snntp_sendcommand(void* lpObj, const char* lpszCommand);

int SendCommand(const QString& qsCommand);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (SNNTP Class)

Signs the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworkssmime_snntp_sign(void* lpObj);

int Sign();

Remarks

This method digitally signs the input data with the certificate provided. Certificates are provided by specifying the Certificate property. The IncludeCertificate property allows you to specify whether to include the certificate when signing the message.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SignAndEncrypt Method (SNNTP Class)

Signs and encrypts the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignAndEncrypt();

Unicode (Windows)
INT SignAndEncrypt();

int ipworkssmime_snntp_signandencrypt(void* lpObj);

int SignAndEncrypt();

Remarks

This method both signs and encrypts the input message into a single PKCS encoded envelope.

Please note that the message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifySignature Method (SNNTP Class)

This method verifies the signature of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworkssmime_snntp_verifysignature(void* lpObj);

int VerifySignature();

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class fails with an error.

If this method is successful, the SignerCert property will contain the certificate information of the message signer.

Note: This function does not attempt to check the validity of the signing certificate.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectionStatus Event (SNNTP Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SNNTPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SNNTPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SNNTPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNNTPConnectionStatusEventParams;

#define EID_SNNTP_CONNECTIONSTATUS 1

virtual INT IPWORKSSMIME_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SNNTPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(SNNTPConnectionStatusEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireConnectionStatus(SNNTPConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

EndTransfer Event (SNNTP Class)

This event is fired when the article text completes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(SNNTPEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} SNNTPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(SNNTPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} SNNTPEndTransferEventParams;

#define EID_SNNTP_ENDTRANSFER 2

virtual INT IPWORKSSMIME_CALL FireEndTransfer(INT &iDirection);

class SNNTPEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(SNNTPEndTransferEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireEndTransfer(SNNTPEndTransferEventParams *e) {...}

Remarks

The purpose of the EndTransfer event is twofold: (1) during article retrieval, it fires when the article body finishes transferring from the NewsServer to the local host; and (2) during article posting, it fires after the article body has been sent to the NewsServer.

If ArticleText is not empty, the EndTransfer event is fired when the ArticleText finishes transferring from the local host to the NewsServer. If ArticleText is empty, the event is not fired.

If a file is attached to the ArticleText through the AttachedFile property, then EndTransfer fires again when the file finishes transferring. Please see the description of the AttachedFile property for more information.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (SNNTP Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SNNTPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SNNTPErrorEventParams;


Unicode (Windows)
virtual INT FireError(SNNTPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SNNTPErrorEventParams;

#define EID_SNNTP_ERROR 3

virtual INT IPWORKSSMIME_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SNNTPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SNNTPErrorEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireError(SNNTPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

GroupList Event (SNNTP Class)

This event is fired while group data transfers (during group listings).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupList(SNNTPGroupListEventParams *e);

typedef struct {
  const char *Group;
  int64 FirstArticle;
  int64 LastArticle;
  int CanPost;
  int reserved;
} SNNTPGroupListEventParams;


Unicode (Windows)
virtual INT FireGroupList(SNNTPGroupListEventParams *e);

typedef struct {
  LPCWSTR Group;
  LONG64 FirstArticle;
  LONG64 LastArticle;
  BOOL CanPost;
  INT reserved;
} SNNTPGroupListEventParams;

#define EID_SNNTP_GROUPLIST 4

virtual INT IPWORKSSMIME_CALL FireGroupList(LPSTR &lpszGroup, LONG64 &lFirstArticle, LONG64 &lLastArticle, BOOL &bCanPost);

class SNNTPGroupListEventParams {
public:
  const QString &Group();

  qint64 FirstArticle();

  qint64 LastArticle();

  bool CanPost();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GroupList(SNNTPGroupListEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireGroupList(SNNTPGroupListEventParams *e) {...}

Remarks

The GroupList event is fired for every group reported by the NewsServer when the ListGroups or ListNewGroups method is called.

The Group parameter shows the name of the group.

The FirstArticle and LastArticle parameters contain the article numbers for the first and last articles in the group.

The CanPost is True or False depending on whether article posting is allowed in the group specified by Group.

GroupOverview Event (SNNTP Class)

This event is fired for each line of article overview data (during group overviews).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupOverview(SNNTPGroupOverviewEventParams *e);

typedef struct {
  int64 ArticleNumber;
  const char *Subject;
  const char *From;
  const char *ArticleDate;
  const char *MessageId;
  const char *References;
  int64 ArticleSize;
  int64 ArticleLines;
  const char *OtherHeaders;
  int reserved;
} SNNTPGroupOverviewEventParams;


Unicode (Windows)
virtual INT FireGroupOverview(SNNTPGroupOverviewEventParams *e);

typedef struct {
  LONG64 ArticleNumber;
  LPCWSTR Subject;
  LPCWSTR From;
  LPCWSTR ArticleDate;
  LPCWSTR MessageId;
  LPCWSTR References;
  LONG64 ArticleSize;
  LONG64 ArticleLines;
  LPCWSTR OtherHeaders;
  INT reserved;
} SNNTPGroupOverviewEventParams;

#define EID_SNNTP_GROUPOVERVIEW 5

virtual INT IPWORKSSMIME_CALL FireGroupOverview(LONG64 &lArticleNumber, LPSTR &lpszSubject, LPSTR &lpszFrom, LPSTR &lpszArticleDate, LPSTR &lpszMessageId, LPSTR &lpszReferences, LONG64 &lArticleSize, LONG64 &lArticleLines, LPSTR &lpszOtherHeaders);

class SNNTPGroupOverviewEventParams {
public:
  qint64 ArticleNumber();

  const QString &Subject();

  const QString &From();

  const QString &ArticleDate();

  const QString &MessageId();

  const QString &References();

  qint64 ArticleSize();

  qint64 ArticleLines();

  const QString &OtherHeaders();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GroupOverview(SNNTPGroupOverviewEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireGroupOverview(SNNTPGroupOverviewEventParams *e) {...}

Remarks

ArticleNumber contains the number of the article within the group.

Subject contains the subject of the article.

From contains the email address of the article author.

ArticleDate contains the date the article was posted.

MessageId contains the unique message Id for the article.

References contains the message Ids for the articles this article refers to (separated by spaces).

ArticleSize contains the size of the article in bytes.

ArticleLines contains the number of lines in the article.

OtherHeaders contains any other article headers that NewsServer chooses to display for the article.

GroupSearch Event (SNNTP Class)

This event is fired for each line of group search data (during group searches).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupSearch(SNNTPGroupSearchEventParams *e);

typedef struct {
  int64 ArticleNumber;
  const char *Header;
  int reserved;
} SNNTPGroupSearchEventParams;


Unicode (Windows)
virtual INT FireGroupSearch(SNNTPGroupSearchEventParams *e);

typedef struct {
  LONG64 ArticleNumber;
  LPCWSTR Header;
  INT reserved;
} SNNTPGroupSearchEventParams;

#define EID_SNNTP_GROUPSEARCH 6

virtual INT IPWORKSSMIME_CALL FireGroupSearch(LONG64 &lArticleNumber, LPSTR &lpszHeader);

class SNNTPGroupSearchEventParams {
public:
  qint64 ArticleNumber();

  const QString &Header();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GroupSearch(SNNTPGroupSearchEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireGroupSearch(SNNTPGroupSearchEventParams *e) {...}

Remarks

ArticleNumber contains the number of the article within the group.

Header contains the matching header.

Header Event (SNNTP Class)

This event is fired for every article header being retrieved during article retrieval.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(SNNTPHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} SNNTPHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(SNNTPHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} SNNTPHeaderEventParams;

#define EID_SNNTP_HEADER 7

virtual INT IPWORKSSMIME_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class SNNTPHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(SNNTPHeaderEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FireHeader(SNNTPHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the header (In the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

PITrail Event (SNNTP Class)

This event traces the commands sent to the news server, and the respective replies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(SNNTPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Message;
  int reserved;
} SNNTPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(SNNTPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} SNNTPPITrailEventParams;

#define EID_SNNTP_PITRAIL 8

virtual INT IPWORKSSMIME_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);

class SNNTPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(SNNTPPITrailEventParams *e);

// Or, subclass SNNTP and override this emitter function.
virtual int FirePITrail(SNNTPPITrailEventParams *e) {...}