diff options
Diffstat (limited to 'certmanager/lib/cryptplug.h')
| -rw-r--r-- | certmanager/lib/cryptplug.h | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/certmanager/lib/cryptplug.h b/certmanager/lib/cryptplug.h index 82cab607..9b281101 100644 --- a/certmanager/lib/cryptplug.h +++ b/certmanager/lib/cryptplug.h @@ -418,12 +418,12 @@ bool hasFeature( ::Feature ); and/or encrypted content (or to build a text frame around your flat non-MIME message body, resp.) - <b>If</b> value returned in \c makeMimeObject is <b>TRUE</b> the + <b>If</b> value returned in \c makeMimeObject is <b>true</b> the text strings returned in \c contentTypeMain and \c contentDispMain and \c contentTEncMain (and, if required, \c content[..]Version and \c bodyTextVersion and \c content[..]Sig) should be used to compose a respective MIME object.<br> - If <b>FALSE</b> the texts returned in \c flatTextPrefix and + If <b>false</b> the texts returned in \c flatTextPrefix and \c flatTextSeparator and \c flatTextPostfix are to be used instead.<br> Allways <b>either</b> the \c content[..] and \c bodyTextVersion parameters <b>or</b> the \c flatText[..] parameters are holding @@ -451,16 +451,16 @@ bool hasFeature( ::Feature ); you could report the missing MIME header information to the address returned by the \c bugURL() function. - If \c makeMultiMime returns FALSE the \c contentTypeMain returned must + If \c makeMultiMime returns false the \c contentTypeMain returned must not be altered but used to specify a single part mime object holding the code bloc, e.g. this is used for 'enveloped-data' single part MIME objects. In this case you should ignore both the \c content[..]Version and \c content[..]Code parameters. - If \c makeMultiMime returns TRUE also the following rules apply: - \li If \c includeCleartext is TRUE you should include the cleartext - as first part of our multipart MIME object, typically this is TRUE - when signing mails but FALSE when encrypting. + If \c makeMultiMime returns true also the following rules apply: + \li If \c includeCleartext is true you should include the cleartext + as first part of our multipart MIME object, typically this is true + when signing mails but false when encrypting. \li The \c contentTypeMain returned typically starts with "multipart/" while providing a "protocol" and a "micalg" parameter: just add an appropriate \c "; boundary=[your \c boundary \c string]" to get @@ -486,16 +486,16 @@ bool hasFeature( ::Feature ); unaltered value to specify the Content-Transfer-Encoding header of the respective MIME part. - <b>If</b> value returned in \c makeMimeObject is <b>FALSE</b> the + <b>If</b> value returned in \c makeMimeObject is <b>false</b> the text strings returned in \c flatTextPrefix and \c flatTextPostfix should be used to build a frame around the cleartext and the code bloc holding the signature (or - in case of encrypting - the encoded data bloc, resp.).<br> - If \c includeCleartext is TRUE this frame should also include the + If \c includeCleartext is true this frame should also include the cleartext as first bloc, this bloc should be divided from the code bloc by the contents of \c flatTextSeparator - typically this is used for signing but not when encrypting.<br> - If \c includeCleartext is FALSE you should ignore both the cleartext + If \c includeCleartext is false you should ignore both the cleartext and the \c flatTextSeparator parameter. <b>How to use StructuringInfo data in your program:</b> @@ -624,48 +624,48 @@ struct StructuringInfo { MIME object (or - for non-MIME messages - as flat text to be set before the ciphertext, resp.), typically this - is TRUE when signing mails but FALSE + is true when signing mails but false when encrypting<br> (this parameter is relevant no matter - whether \c makeMimeObject is TRUE or - FALSE) */ + whether \c makeMimeObject is true or + false) */ bool makeMimeObject; /*!< specifies whether we should create a MIME object or a flat text message body */ /* the following are used for MIME messages only */ bool makeMultiMime; /*!< specifies whether we should create a 'Multipart' MIME object or a single part - object, if FALSE only \c contentTypeMain, + object, if false only \c contentTypeMain, \c contentDispMain and \c contentTEncMain may be used and all other parameters have to be ignored<br> (ignore this parameter if \c makeMimeObject - is FALSE) */ + is false) */ char* contentTypeMain; /*!< value of the main 'Content-Type' header<br> (ignore this parameter if \c makeMimeObject - is FALSE) */ + is false) */ char* contentDispMain; /*!< value of the main 'Content-Disposition' header<br> (ignore this parameter if \c makeMimeObject - is FALSE) */ + is false) */ char* contentTEncMain; /*!< value of the main 'Content-TransferEncoding' header<br> (ignore this parameter if \c makeMimeObject - is FALSE) */ + is false) */ char* contentTypeVersion; /*!< 'Content-Type' of the additional version part that might preceed the code part - if NULL or zero length no version part must be created<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE) */ + is false) */ char* contentDispVersion; /*!< 'Content-Disposition' of the additional preceeding the code part (only valid if \c contentTypeVersion holds a non-zero-length string)<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE or if \c contentTypeVersion does + is false or if \c contentTypeVersion does not return a non-zero-length string) */ char* contentTEncVersion; /*!< 'Content-Transfer-Encoding' of the additional version part (only valid if @@ -673,47 +673,47 @@ struct StructuringInfo { non-zero-length string)<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE or if \c contentTypeVersion does + is false or if \c contentTypeVersion does not return a non-zero-length string) */ char* bodyTextVersion; /*!< body text of the additional version part (only valid if \c contentTypeVersion holds a non-zero-length string)<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE or if \c contentTypeVersion does + is false or if \c contentTypeVersion does not return a non-zero-length string) */ char* contentTypeCode; /*!< 'Content-Type' of the code part holding the signature code (or the encrypted data, resp.)<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE) */ + is false) */ char* contentDispCode; /*!< 'Content-Disposition' of the code part<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE or if \c contentTypeCode does + is false or if \c contentTypeCode does not return a non-zero-length string) */ char* contentTEncCode; /*!< 'Content-Type' of the code part<br> (ignore this parameter if either \c makeMimeObject or \c makeMultiMime - is FALSE or if \c contentTypeCode does + is false or if \c contentTypeCode does not return a non-zero-length string) */ /* the following are used for flat non-MIME messages only */ char* flatTextPrefix; /*!< text to preceed the main text (or the code bloc containing the encrypted main text, resp.)<br> (ignore this parameter if - \c makeMimeObject is TRUE) */ + \c makeMimeObject is true) */ char* flatTextSeparator; /*!< text to be put between the main text and the signature code bloc (not used when encrypting)<br> (ignore this parameter if - \c makeMimeObject is TRUE or if - \c includeCleartext is FALSE) */ + \c makeMimeObject is true or if + \c includeCleartext is false) */ char* flatTextPostfix; /*!< text to follow the signature code bloc (or the encrypted data bloc, resp.)<br> (ignore this parameter if - \c makeMimeObject is TRUE) */ + \c makeMimeObject is true) */ }; |