TElDomainKeysSigner.Sign method

TElDomainKeysSigner.Sign

TElDomainKeysSigner

Filter: C# VB.NET Pascal C++ PHP Java

Calculates signature for the message and generates service MIME-field for message header.

Declaration

[C#]
int Sign(TElStringList Signature);

[VB.NET]
Function Sign(ByVal Signature As TElStringList) As Integer

[Pascal]
function Sign(Signature: TStrings): Integer;

[C++]
int32_t Sign(TStrings &Signature);
int32_t Sign(TStrings *Signature);

[PHP]
integer Sign(TStrings $Signature)

[Java]
int sign(TElStringList Signature);

Parameters

Signature - created signature

Return value

Returns error code.

Values of error codes:

[.NET] [Pascal] [C++]	Value	Description
SB_DK_SIGNER_ERROR_SUCCESS	0 (0x0000)	Header processing: message header was processed successfully and message can be signed.Body line processing: message body line was processed successfully.Signing: signature was generated successfully.
SB_DK_SIGNER_ERROR_INVALID_STATE	1 (0x0001)	wrong order of methods calling.
SB_DK_SIGNER_ERROR_INVALID_HEADER	2 (0x0002)	Header processing: massage header has wrong format.
SB_DK_SIGNER_ERROR_EMPTY_HEADER	3 (0x0003)	Header processing: message header is empty.
SB_DK_SIGNER_ERROR_INVALID_SENDER	4 (0x0004)	Header processing: message header contains "Sender:" field but it has wrong format or has no e-mail address.
SB_DK_SIGNER_ERROR_SEVERAL_SENDERS	5 (0x0005)	Header processing: "Sender:" header field contains several e-mail addresses.
SB_DK_SIGNER_ERROR_NO_PRIVATE_KEY	6 (0x0006)	Signing: private key is not specified.
SB_DK_SIGNER_ERROR_NO_SELECTOR	7 (0x0007)	Signing: selector is not specified.
SB_DK_SIGNER_ERROR_NO_DOMAIN	8 (0x0008)	Header processing: "Sender:" and "From:" header fields do not contain correct e-mail address so it is impossible to find out name of the domain which key has to be used for signing.Signing: the message can not be signed as it is impossible to find out the name of the domain whose key has to be used for signing.
SB_DK_SIGNER_ERROR_NO_AUTHOR	9 (0x0009)	Header processing: "Sender:" and "From:" header fields are absent.
SB_DK_SIGNER_ERROR_FAILURE	10 (0x000A)	Signing: internal error during signature calculation or header generation.

Description

Use this method when you want to generate MIME-field with signature. This field must be placed in the beginning of the message header.

Discuss this help topic in SecureBlackbox Forum