IPWorks S/MIME 2020 C++ Edition

Questions / Feedback?

Encrypt Method

Encrypts the message.

Syntax

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();
- (void)encrypt;
#define MID_SMIME_ENCRYPT 6

IPWORKSSMIME_EXTERNAL int IPWORKSSMIME_CALL IPWorksSMIME_SMIME_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method encrypts the data specified in InputFile or InputMessage in a PKCS encoded envelope with all of the recipient certificates specified in the MessageRecipients properties.

The result of the encrypted data will be written to OutputFile or OutputMessage. The OutputMessageHeaders property will be filled with the required S/MIME headers.

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.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

  • SetOutputStream
  • OutputFile
  • OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.

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.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 C++ Edition - Version 20.0 [Build 8154]