MailWriter Class

Properties   Methods   Events   Config Settings   Errors  

The MailWriter class composes, encrypts, and signs e-mail messages.

Class Name

SecureBlackbox_MailWriter

Procedural Interface

 secureblackbox_mailwriter_open();
 secureblackbox_mailwriter_close($res);
 secureblackbox_mailwriter_register_callback($res, $id, $function);
 secureblackbox_mailwriter_get_last_error($res);
 secureblackbox_mailwriter_get_last_error_code($res);
 secureblackbox_mailwriter_set($res, $id, $index, $value);
 secureblackbox_mailwriter_get($res, $id, $index);
 secureblackbox_mailwriter_do_attachbytes($res, $data);
 secureblackbox_mailwriter_do_attachfile($res, $filename);
 secureblackbox_mailwriter_do_attachimage($res, $id, $data);
 secureblackbox_mailwriter_do_config($res, $configurationstring);
 secureblackbox_mailwriter_do_doaction($res, $actionid, $actionparams);
 secureblackbox_mailwriter_do_savetobytes($res);
 secureblackbox_mailwriter_do_savetofile($res, $filename);

Remarks

Use MailWriter to compose, sign, and encrypt e-mail messages, and prepare them for sending or saving.

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.

AttachEncoding Property (SecureBlackbox_MailWriter Class)

The encoding to be applied to the attachments.

Object Oriented Interface

public function getAttachEncoding();


public function setAttachEncoding($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 1 );


secureblackbox_mailwriter_set($res, 1, $value );

Default Value

0

Remarks

Use this property to specify the encoding method for the attached files.

Data Type

Integer

AttachCount Property (SecureBlackbox_MailWriter Class)

The number of records in the Attach arrays.

Object Oriented Interface

public function getAttachCount();


public function setAttachCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 2 );


secureblackbox_mailwriter_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachContentSubtype
• AttachContentType
• AttachCreationDate
• AttachData
• AttachDescription
• AttachFilename
• AttachHandle
• AttachID
• AttachModificationDate
• AttachReadDate
• AttachSize

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

This property is not available at design time.

Data Type

Integer

AttachContentSubtype Property (SecureBlackbox_MailWriter Class)

Contains the content subtype of the attachment.

Object Oriented Interface

public function getAttachContentSubtype($attachindex);


public function setAttachContentSubtype($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 3 , $attachindex);


secureblackbox_mailwriter_set($res, 3, $value , $attachindex);

Default Value

''

Remarks

Contains the content subtype of the attachment.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachContentType Property (SecureBlackbox_MailWriter Class)

Contains the content type of the attachment.

Object Oriented Interface

public function getAttachContentType($attachindex);


public function setAttachContentType($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 4 , $attachindex);


secureblackbox_mailwriter_set($res, 4, $value , $attachindex);

Default Value

''

Remarks

Contains the content type of the attachment.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachCreationDate Property (SecureBlackbox_MailWriter Class)

The creation date.

Object Oriented Interface

public function getAttachCreationDate($attachindex);


public function setAttachCreationDate($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 5 , $attachindex);


secureblackbox_mailwriter_set($res, 5, $value , $attachindex);

Default Value

''

Remarks

The creation date.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachData Property (SecureBlackbox_MailWriter Class)

The content of the attachment.

Object Oriented Interface

public function getAttachData($attachindex);


public function setAttachData($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 6 , $attachindex);


secureblackbox_mailwriter_set($res, 6, $value , $attachindex);

Remarks

The content of the attachment.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

Byte Array

AttachDescription Property (SecureBlackbox_MailWriter Class)

Textual description of the attachment.

Object Oriented Interface

public function getAttachDescription($attachindex);


public function setAttachDescription($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 7 , $attachindex);


secureblackbox_mailwriter_set($res, 7, $value , $attachindex);

Default Value

''

Remarks

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachFilename Property (SecureBlackbox_MailWriter Class)

Specifies the name of the attachment file.

Object Oriented Interface

public function getAttachFilename($attachindex);


public function setAttachFilename($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 8 , $attachindex);


secureblackbox_mailwriter_set($res, 8, $value , $attachindex);

Default Value

''

Remarks

Specifies the name of the attachment file.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachHandle Property (SecureBlackbox_MailWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getAttachHandle($attachindex);


public function setAttachHandle($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 9 , $attachindex);


secureblackbox_mailwriter_set($res, 9, $value , $attachindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

Long64

AttachID Property (SecureBlackbox_MailWriter Class)

Contains the attachment's unique identifier.

Object Oriented Interface

public function getAttachID($attachindex);


public function setAttachID($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 10 , $attachindex);


secureblackbox_mailwriter_set($res, 10, $value , $attachindex);

Default Value

''

Remarks

Contains the attachment's unique identifier.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachModificationDate Property (SecureBlackbox_MailWriter Class)

Specifies the date and time of the file's last modification.

Object Oriented Interface

public function getAttachModificationDate($attachindex);


public function setAttachModificationDate($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 11 , $attachindex);


secureblackbox_mailwriter_set($res, 11, $value , $attachindex);

Default Value

''

Remarks

Specifies the date and time of the file's last modification.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachReadDate Property (SecureBlackbox_MailWriter Class)

Specifies the file's last read date.

Object Oriented Interface

public function getAttachReadDate($attachindex);


public function setAttachReadDate($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 12 , $attachindex);


secureblackbox_mailwriter_set($res, 12, $value , $attachindex);

Default Value

''

Remarks

Specifies the file's last read date.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

String

AttachSize Property (SecureBlackbox_MailWriter Class)

The attachment's size in bytes.

Object Oriented Interface

public function getAttachSize($attachindex);


public function setAttachSize($attachindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 13 , $attachindex);


secureblackbox_mailwriter_set($res, 13, $value , $attachindex);

Default Value

0

Remarks

The attachment's size in bytes.

The $attachindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

This property is not available at design time.

Data Type

Long64

BccAddrCount Property (SecureBlackbox_MailWriter Class)

The number of records in the BccAddr arrays.

Object Oriented Interface

public function getBccAddrCount();


public function setBccAddrCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 14 );


secureblackbox_mailwriter_set($res, 14, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BccAddrAddress
• BccAddrDisplayName
• BccAddrGroupName

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

This property is not available at design time.

Data Type

Integer

BccAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getBccAddrAddress($bccaddrindex);


public function setBccAddrAddress($bccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 15 , $bccaddrindex);


secureblackbox_mailwriter_set($res, 15, $value , $bccaddrindex);

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

The $bccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

This property is not available at design time.

Data Type

String

BccAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getBccAddrDisplayName($bccaddrindex);


public function setBccAddrDisplayName($bccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 16 , $bccaddrindex);


secureblackbox_mailwriter_set($res, 16, $value , $bccaddrindex);

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The $bccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

This property is not available at design time.

Data Type

String

BccAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getBccAddrGroupName($bccaddrindex);


public function setBccAddrGroupName($bccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 17 , $bccaddrindex);


secureblackbox_mailwriter_set($res, 17, $value , $bccaddrindex);

Default Value

''

Remarks

The name of the group this address belongs to.

The $bccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

This property is not available at design time.

Data Type

String

CcAddrCount Property (SecureBlackbox_MailWriter Class)

The number of records in the CcAddr arrays.

Object Oriented Interface

public function getCcAddrCount();


public function setCcAddrCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 18 );


secureblackbox_mailwriter_set($res, 18, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CcAddrAddress
• CcAddrDisplayName
• CcAddrGroupName

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

This property is not available at design time.

Data Type

Integer

CcAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getCcAddrAddress($ccaddrindex);


public function setCcAddrAddress($ccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 19 , $ccaddrindex);


secureblackbox_mailwriter_set($res, 19, $value , $ccaddrindex);

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

The $ccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

This property is not available at design time.

Data Type

String

CcAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getCcAddrDisplayName($ccaddrindex);


public function setCcAddrDisplayName($ccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 20 , $ccaddrindex);


secureblackbox_mailwriter_set($res, 20, $value , $ccaddrindex);

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The $ccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

This property is not available at design time.

Data Type

String

CcAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getCcAddrGroupName($ccaddrindex);


public function setCcAddrGroupName($ccaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 21 , $ccaddrindex);


secureblackbox_mailwriter_set($res, 21, $value , $ccaddrindex);

Default Value

''

Remarks

The name of the group this address belongs to.

The $ccaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

This property is not available at design time.

Data Type

String

Charset Property (SecureBlackbox_MailWriter Class)

The charset to apply to Message .

Object Oriented Interface

public function getCharset();


public function setCharset($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 22 );


secureblackbox_mailwriter_set($res, 22, $value );

Default Value

'utf-8'

Remarks

Use this property to specify the character set to use in the message.

Data Type

String

EncryptionCertCount Property (SecureBlackbox_MailWriter Class)

The number of records in the EncryptionCert arrays.

Object Oriented Interface

public function getEncryptionCertCount();


public function setEncryptionCertCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 23 );


secureblackbox_mailwriter_set($res, 23, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptionCertBytes
• EncryptionCertHandle

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

This property is not available at design time.

Data Type

Integer

EncryptionCertBytes Property (SecureBlackbox_MailWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes($encryptioncertindex);

Procedural Interface

secureblackbox_mailwriter_get($res, 24 , $encryptioncertindex);

Remarks

Returns the raw certificate data in DER format.

The $encryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

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

Data Type

Byte Array

EncryptionCertHandle Property (SecureBlackbox_MailWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getEncryptionCertHandle($encryptioncertindex);


public function setEncryptionCertHandle($encryptioncertindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 31 , $encryptioncertindex);


secureblackbox_mailwriter_set($res, 31, $value , $encryptioncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $encryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is not available at design time.

Data Type

Long64

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_MailWriter Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 58 );


secureblackbox_mailwriter_set($res, 58, $value );

Default Value

''

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_MailWriter Class)

Custom parameters to be passed to the signing service (uninterpreted).

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 59 );


secureblackbox_mailwriter_set($res, 59, $value );

Default Value

''

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_MailWriter Class)

Additional data to be included in the async state and mirrored back by the requestor.

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 60 );


secureblackbox_mailwriter_set($res, 60, $value );

Default Value

''

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_MailWriter Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 61 );


secureblackbox_mailwriter_set($res, 61, $value );

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_MailWriter Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 62 );


secureblackbox_mailwriter_set($res, 62, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_MailWriter Class)

The ID of the pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 63 );


secureblackbox_mailwriter_set($res, 63, $value );

Default Value

''

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_MailWriter Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 64 );


secureblackbox_mailwriter_set($res, 64, $value );

Default Value

''

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_MailWriter Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 65 );


secureblackbox_mailwriter_set($res, 65, $value );

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_MailWriter Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 66 );


secureblackbox_mailwriter_set($res, 66, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_MailWriter Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 67 );


secureblackbox_mailwriter_set($res, 67, $value );

Default Value

''

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SecureBlackbox_MailWriter Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 68 );


secureblackbox_mailwriter_set($res, 68, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

FromAddrCount Property (SecureBlackbox_MailWriter Class)

The number of records in the FromAddr arrays.

Object Oriented Interface

public function getFromAddrCount();


public function setFromAddrCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 69 );


secureblackbox_mailwriter_set($res, 69, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• FromAddrAddress
• FromAddrDisplayName
• FromAddrGroupName

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

This property is not available at design time.

Data Type

Integer

FromAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getFromAddrAddress($fromaddrindex);


public function setFromAddrAddress($fromaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 70 , $fromaddrindex);


secureblackbox_mailwriter_set($res, 70, $value , $fromaddrindex);

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

The $fromaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

This property is not available at design time.

Data Type

String

FromAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getFromAddrDisplayName($fromaddrindex);


public function setFromAddrDisplayName($fromaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 71 , $fromaddrindex);


secureblackbox_mailwriter_set($res, 71, $value , $fromaddrindex);

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The $fromaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

This property is not available at design time.

Data Type

String

FromAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getFromAddrGroupName($fromaddrindex);


public function setFromAddrGroupName($fromaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 72 , $fromaddrindex);


secureblackbox_mailwriter_set($res, 72, $value , $fromaddrindex);

Default Value

''

Remarks

The name of the group this address belongs to.

The $fromaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

This property is not available at design time.

Data Type

String

HeaderEncoding Property (SecureBlackbox_MailWriter Class)

The encoding to be applied to the message header.

Object Oriented Interface

public function getHeaderEncoding();


public function setHeaderEncoding($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 73 );


secureblackbox_mailwriter_set($res, 73, $value );

Default Value

0

Remarks

Use this property to specify the encoding to use with the message header.

Data Type

Integer

Mailer Property (SecureBlackbox_MailWriter Class)

The name of the software used to compose and/or send the message.

Object Oriented Interface

public function getMailer();


public function setMailer($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 74 );


secureblackbox_mailwriter_set($res, 74, $value );

Default Value

''

Remarks

Use this property to specify the software that was used to compose and send this message.

Data Type

String

MsgAttachmentCount Property (SecureBlackbox_MailWriter Class)

Returns the number of attachments in this message.

Object Oriented Interface

public function getMsgAttachmentCount();

Procedural Interface

secureblackbox_mailwriter_get($res, 75 );

Default Value

0

Remarks

Returns the number of attachments in this message.

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

Data Type

Integer

MsgBcc Property (SecureBlackbox_MailWriter Class)

The contents of the BCC header property.

Object Oriented Interface

public function getMsgBcc();


public function setMsgBcc($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 76 );


secureblackbox_mailwriter_set($res, 76, $value );

Default Value

''

Remarks

The contents of the BCC header field.

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

This property is not available at design time.

Data Type

String

MsgCc Property (SecureBlackbox_MailWriter Class)

The value of the CC header property.

Object Oriented Interface

public function getMsgCc();


public function setMsgCc($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 77 );


secureblackbox_mailwriter_set($res, 77, $value );

Default Value

''

Remarks

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

This property is not available at design time.

Data Type

String

MsgComments Property (SecureBlackbox_MailWriter Class)

Contains additional information about the message body.

Object Oriented Interface

public function getMsgComments();


public function setMsgComments($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 78 );


secureblackbox_mailwriter_set($res, 78, $value );

Default Value

''

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (SecureBlackbox_MailWriter Class)

The date and time when the message entered the mail delivery system.

Object Oriented Interface

public function getMsgDate();


public function setMsgDate($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 79 );


secureblackbox_mailwriter_set($res, 79, $value );

Default Value

''

Remarks

The date and time when the message entered the mail delivery system.

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

This property is not available at design time.

Data Type

String

MsgDeliveryReceipt Property (SecureBlackbox_MailWriter Class)

Enables delivery notification.

Object Oriented Interface

public function getMsgDeliveryReceipt();


public function setMsgDeliveryReceipt($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 80 );


secureblackbox_mailwriter_set($res, 80, $value );

Default Value

false

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (SecureBlackbox_MailWriter Class)

Contains the value of the From header property.

Object Oriented Interface

public function getMsgFrom();


public function setMsgFrom($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 81 );


secureblackbox_mailwriter_set($res, 81, $value );

Default Value

''

Remarks

Contains the value of the From header field.

This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use MsgSender to specify the sender separately.

This property is not available at design time.

Data Type

String

MsgHandle Property (SecureBlackbox_MailWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getMsgHandle();


public function setMsgHandle($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 82 );


secureblackbox_mailwriter_set($res, 82, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

MsgHtmlText Property (SecureBlackbox_MailWriter Class)

The HTML version of the message.

Object Oriented Interface

public function getMsgHtmlText();


public function setMsgHtmlText($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 83 );


secureblackbox_mailwriter_set($res, 83, $value );

Default Value

''

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (SecureBlackbox_MailWriter Class)

The contents of the Message-ID header property.

Object Oriented Interface

public function getMsgID();


public function setMsgID($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 84 );


secureblackbox_mailwriter_set($res, 84, $value );

Default Value

''

Remarks

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

This property is not available at design time.

Data Type

String

MsgInReplyTo Property (SecureBlackbox_MailWriter Class)

The value of the In-Reply-To header property.

Object Oriented Interface

public function getMsgInReplyTo();


public function setMsgInReplyTo($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 85 );


secureblackbox_mailwriter_set($res, 85, $value );

Default Value

''

Remarks

The value of the In-Reply-To header field.

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

This property is not available at design time.

Data Type

String

MsgKeywords Property (SecureBlackbox_MailWriter Class)

The value of the Keywords header property.

Object Oriented Interface

public function getMsgKeywords();


public function setMsgKeywords($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 86 );


secureblackbox_mailwriter_set($res, 86, $value );

Default Value

''

Remarks

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

This property is not available at design time.

Data Type

String

MsgMailer Property (SecureBlackbox_MailWriter Class)

The name of the software that was used to send the message.

Object Oriented Interface

public function getMsgMailer();

Procedural Interface

secureblackbox_mailwriter_get($res, 87 );

Default Value

''

Remarks

The name of the software that was used to send the message.

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

Data Type

String

MsgPlainText Property (SecureBlackbox_MailWriter Class)

The plain text version of the message.

Object Oriented Interface

public function getMsgPlainText();


public function setMsgPlainText($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 88 );


secureblackbox_mailwriter_set($res, 88, $value );

Default Value

''

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (SecureBlackbox_MailWriter Class)

Specifies the message priority.

Object Oriented Interface

public function getMsgPriority();


public function setMsgPriority($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 89 );


secureblackbox_mailwriter_set($res, 89, $value );

Default Value

2

Remarks

Specifies the message priority.

Available options:

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (SecureBlackbox_MailWriter Class)

Enables a read notification.

Object Oriented Interface

public function getMsgReadReceipt();


public function setMsgReadReceipt($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 90 );


secureblackbox_mailwriter_set($res, 90, $value );

Default Value

false

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (SecureBlackbox_MailWriter Class)

The value of the References header property.

Object Oriented Interface

public function getMsgReferences();


public function setMsgReferences($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 91 );


secureblackbox_mailwriter_set($res, 91, $value );

Default Value

''

Remarks

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

This property is not available at design time.

Data Type

String

MsgReplyTo Property (SecureBlackbox_MailWriter Class)

The value of the Reply-To header property.

Object Oriented Interface

public function getMsgReplyTo();


public function setMsgReplyTo($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 92 );


secureblackbox_mailwriter_set($res, 92, $value );

Default Value

''

Remarks

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the MsgFrom field.

This property is not available at design time.

Data Type

String

MsgReturnPath Property (SecureBlackbox_MailWriter Class)

The value of the Return-Path header property.

Object Oriented Interface

public function getMsgReturnPath();


public function setMsgReturnPath($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 93 );


secureblackbox_mailwriter_set($res, 93, $value );

Default Value

''

Remarks

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

This property is not available at design time.

Data Type

String

MsgSender Property (SecureBlackbox_MailWriter Class)

The value of the Sender header property.

Object Oriented Interface

public function getMsgSender();


public function setMsgSender($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 94 );


secureblackbox_mailwriter_set($res, 94, $value );

Default Value

''

Remarks

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

This property is not available at design time.

Data Type

String

MsgSendTo Property (SecureBlackbox_MailWriter Class)

The value of the To header property.

Object Oriented Interface

public function getMsgSendTo();


public function setMsgSendTo($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 95 );


secureblackbox_mailwriter_set($res, 95, $value );

Default Value

''

Remarks

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

This property is not available at design time.

Data Type

String

MsgSubject Property (SecureBlackbox_MailWriter Class)

Contains the subject property of this message.

Object Oriented Interface

public function getMsgSubject();


public function setMsgSubject($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 96 );


secureblackbox_mailwriter_set($res, 96, $value );

Default Value

''

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

HeaderFieldCount Property (SecureBlackbox_MailWriter Class)

The number of records in the HeaderField arrays.

Object Oriented Interface

public function getHeaderFieldCount();


public function setHeaderFieldCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 97 );


secureblackbox_mailwriter_set($res, 97, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• HeaderFieldCategory
• HeaderFieldFormat
• HeaderFieldName
• HeaderFieldValue

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

This property is not available at design time.

Data Type

Integer

HeaderFieldCategory Property (SecureBlackbox_MailWriter Class)

Specifies the string category of the contained value.

Object Oriented Interface

public function getHeaderFieldCategory($headerfieldindex);


public function setHeaderFieldCategory($headerfieldindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 98 , $headerfieldindex);


secureblackbox_mailwriter_set($res, 98, $value , $headerfieldindex);

Default Value

''

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The $headerfieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

This property is not available at design time.

Data Type

String

HeaderFieldFormat Property (SecureBlackbox_MailWriter Class)

Specifies the format (encoding) of the value contained in the Value property.

Object Oriented Interface

public function getHeaderFieldFormat($headerfieldindex);


public function setHeaderFieldFormat($headerfieldindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 99 , $headerfieldindex);


secureblackbox_mailwriter_set($res, 99, $value , $headerfieldindex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the HeaderFieldValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The $headerfieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

This property is not available at design time.

Data Type

Integer

HeaderFieldName Property (SecureBlackbox_MailWriter Class)

The name element in a (name, value) pair.

Object Oriented Interface

public function getHeaderFieldName($headerfieldindex);


public function setHeaderFieldName($headerfieldindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 100 , $headerfieldindex);


secureblackbox_mailwriter_set($res, 100, $value , $headerfieldindex);

Default Value

''

Remarks

The name element in a (name, value) pair.

The $headerfieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

This property is not available at design time.

Data Type

String

HeaderFieldValue Property (SecureBlackbox_MailWriter Class)

The value element in a (name, value) pair.

Object Oriented Interface

public function getHeaderFieldValue($headerfieldindex);


public function setHeaderFieldValue($headerfieldindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 101 , $headerfieldindex);


secureblackbox_mailwriter_set($res, 101, $value , $headerfieldindex);

Default Value

''

Remarks

The value element in a (name, value) pair.

The $headerfieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

This property is not available at design time.

Data Type

String

Profile Property (SecureBlackbox_MailWriter Class)

Specifies a pre-defined profile to apply when creating the signature.

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 102 );


secureblackbox_mailwriter_set($res, 102, $value );

Default Value

''

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ReplyToAddrCount Property (SecureBlackbox_MailWriter Class)

The number of records in the ReplyToAddr arrays.

Object Oriented Interface

public function getReplyToAddrCount();


public function setReplyToAddrCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 103 );


secureblackbox_mailwriter_set($res, 103, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReplyToAddrAddress
• ReplyToAddrDisplayName
• ReplyToAddrGroupName

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

This property is not available at design time.

Data Type

Integer

ReplyToAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getReplyToAddrAddress($replytoaddrindex);


public function setReplyToAddrAddress($replytoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 104 , $replytoaddrindex);


secureblackbox_mailwriter_set($res, 104, $value , $replytoaddrindex);

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

The $replytoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

This property is not available at design time.

Data Type

String

ReplyToAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getReplyToAddrDisplayName($replytoaddrindex);


public function setReplyToAddrDisplayName($replytoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 105 , $replytoaddrindex);


secureblackbox_mailwriter_set($res, 105, $value , $replytoaddrindex);

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The $replytoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

This property is not available at design time.

Data Type

String

ReplyToAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getReplyToAddrGroupName($replytoaddrindex);


public function setReplyToAddrGroupName($replytoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 106 , $replytoaddrindex);


secureblackbox_mailwriter_set($res, 106, $value , $replytoaddrindex);

Default Value

''

Remarks

The name of the group this address belongs to.

The $replytoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

This property is not available at design time.

Data Type

String

SecSettingsClaimedSigningTime Property (SecureBlackbox_MailWriter Class)

Specifies the signing time from the signer's computer.

Object Oriented Interface

public function getSecSettingsClaimedSigningTime();


public function setSecSettingsClaimedSigningTime($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 107 );


secureblackbox_mailwriter_set($res, 107, $value );

Default Value

''

Remarks

Specifies the signing time from the signer's computer.

Use this property to specify the signature production time. The claimed time is not covered by the signature, may be forfeited or wrong, and as such is usually taken by verifiers for informational purposes only.

Data Type

String

SecSettingsEncrypt Property (SecureBlackbox_MailWriter Class)

Whether to encrypt the message.

Object Oriented Interface

public function getSecSettingsEncrypt();


public function setSecSettingsEncrypt($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 108 );


secureblackbox_mailwriter_set($res, 108, $value );

Default Value

false

Remarks

Whether to encrypt the message.

Data Type

Boolean

SecSettingsEncryptionAlgorithm Property (SecureBlackbox_MailWriter Class)

Specifies the encryption algorithm to be used.

Object Oriented Interface

public function getSecSettingsEncryptionAlgorithm();


public function setSecSettingsEncryptionAlgorithm($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 109 );


secureblackbox_mailwriter_set($res, 109, $value );

Default Value

'AES128'

Remarks

Specifies the encryption algorithm to be used.

Data Type

String

SecSettingsHashAlgorithm Property (SecureBlackbox_MailWriter Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getSecSettingsHashAlgorithm();


public function setSecSettingsHashAlgorithm($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 110 );


secureblackbox_mailwriter_set($res, 110, $value );

Default Value

'SHA256'

Remarks

Specifies the hash algorithm to be used.

Data Type

String

SecSettingsSign Property (SecureBlackbox_MailWriter Class)

Whether to sign the message.

Object Oriented Interface

public function getSecSettingsSign();


public function setSecSettingsSign($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 111 );


secureblackbox_mailwriter_set($res, 111, $value );

Default Value

false

Remarks

Whether to sign the message.

Data Type

Boolean

SecSettingsSignatureFormat Property (SecureBlackbox_MailWriter Class)

Specifies the signature format to use for the signed message.

Object Oriented Interface

public function getSecSettingsSignatureFormat();


public function setSecSettingsSignatureFormat($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 112 );


secureblackbox_mailwriter_set($res, 112, $value );

Default Value

0

Remarks

Specifies the signature format to use for the signed message.

Available options:

Data Type

Integer

SecSettingsSignBeforeEncrypt Property (SecureBlackbox_MailWriter Class)

Specifies the order of encryption and signing operations.

Object Oriented Interface

public function getSecSettingsSignBeforeEncrypt();


public function setSecSettingsSignBeforeEncrypt($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 113 );


secureblackbox_mailwriter_set($res, 113, $value );

Default Value

true

Remarks

Specifies the order of encryption and signing operations.

Data Type

Boolean

SecSettingsSignMessageHeader Property (SecureBlackbox_MailWriter Class)

Specifies whether to include the message header in the signature calculation.

Object Oriented Interface

public function getSecSettingsSignMessageHeader();


public function setSecSettingsSignMessageHeader($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 114 );


secureblackbox_mailwriter_set($res, 114, $value );

Default Value

false

Remarks

Specifies whether to include the message header in the signature calculation.

Data Type

Boolean

SenderAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getSenderAddrAddress();


public function setSenderAddrAddress($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 115 );


secureblackbox_mailwriter_set($res, 115, $value );

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

This property is not available at design time.

Data Type

String

SenderAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getSenderAddrDisplayName();


public function setSenderAddrDisplayName($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 116 );


secureblackbox_mailwriter_set($res, 116, $value );

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

This property is not available at design time.

Data Type

String

SenderAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getSenderAddrGroupName();


public function setSenderAddrGroupName($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 117 );


secureblackbox_mailwriter_set($res, 117, $value );

Default Value

''

Remarks

The name of the group this address belongs to.

This property is not available at design time.

Data Type

String

SendToAddrCount Property (SecureBlackbox_MailWriter Class)

The number of records in the SendToAddr arrays.

Object Oriented Interface

public function getSendToAddrCount();


public function setSendToAddrCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 118 );


secureblackbox_mailwriter_set($res, 118, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SendToAddrAddress
• SendToAddrDisplayName
• SendToAddrGroupName

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

This property is not available at design time.

Data Type

Integer

SendToAddrAddress Property (SecureBlackbox_MailWriter Class)

Contains the e-mail address in the form of john@doe.

Object Oriented Interface

public function getSendToAddrAddress($sendtoaddrindex);


public function setSendToAddrAddress($sendtoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 119 , $sendtoaddrindex);


secureblackbox_mailwriter_set($res, 119, $value , $sendtoaddrindex);

Default Value

''

Remarks

Contains the e-mail address in the form of john@doe.com.

The $sendtoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

This property is not available at design time.

Data Type

String

SendToAddrDisplayName Property (SecureBlackbox_MailWriter Class)

Contains the friendly name of the user of this address, such as John Doe.

Object Oriented Interface

public function getSendToAddrDisplayName($sendtoaddrindex);


public function setSendToAddrDisplayName($sendtoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 120 , $sendtoaddrindex);


secureblackbox_mailwriter_set($res, 120, $value , $sendtoaddrindex);

Default Value

''

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The $sendtoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

This property is not available at design time.

Data Type

String

SendToAddrGroupName Property (SecureBlackbox_MailWriter Class)

The name of the group this address belongs to.

Object Oriented Interface

public function getSendToAddrGroupName($sendtoaddrindex);


public function setSendToAddrGroupName($sendtoaddrindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 121 , $sendtoaddrindex);


secureblackbox_mailwriter_set($res, 121, $value , $sendtoaddrindex);

Default Value

''

Remarks

The name of the group this address belongs to.

The $sendtoaddrindex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

This property is not available at design time.

Data Type

String

SigningCertBytes Property (SecureBlackbox_MailWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_mailwriter_get($res, 122 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_MailWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningCertHandle();


public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 129 );


secureblackbox_mailwriter_set($res, 129, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_MailWriter Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 156 );


secureblackbox_mailwriter_set($res, 156, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_MailWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_mailwriter_get($res, 157 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_MailWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_mailwriter_get($res, 164 , $signingchainindex);


secureblackbox_mailwriter_set($res, 164, $value , $signingchainindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

TextEncoding Property (SecureBlackbox_MailWriter Class)

The encoding to be applied to the message.

Object Oriented Interface

public function getTextEncoding();


public function setTextEncoding($value);

Procedural Interface

secureblackbox_mailwriter_get($res, 191 );


secureblackbox_mailwriter_set($res, 191, $value );

Default Value

0

Remarks

Use this property to specify the encoding to use for the content of the message.

Data Type

Integer

AttachBytes Method (SecureBlackbox_MailWriter Class)

Creates an attachment from a memory buffer.

Object Oriented Interface

public function doAttachBytes($data);

Procedural Interface

secureblackbox_mailwriter_do_attachbytes($res, $data);

Remarks

Use this method to create an attachment from a memory buffer. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

AttachFile Method (SecureBlackbox_MailWriter Class)

Creates an attachment from a file.

Object Oriented Interface

public function doAttachFile($filename);

Procedural Interface

secureblackbox_mailwriter_do_attachfile($res, $filename);

Remarks

Use this method to create an attachment from a file. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

AttachImage Method (SecureBlackbox_MailWriter Class)

Creates an image attachment from a memory buffer.

Object Oriented Interface

public function doAttachImage($id, $data);

Procedural Interface

secureblackbox_mailwriter_do_attachimage($res, $id, $data);

Remarks

Use this method to create a picture attachment from a memory buffer. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

Config Method (SecureBlackbox_MailWriter Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_mailwriter_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_MailWriter Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_mailwriter_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

SaveToBytes Method (SecureBlackbox_MailWriter Class)

Serializes the message to a byte array.

Object Oriented Interface

public function doSaveToBytes();

Procedural Interface

secureblackbox_mailwriter_do_savetobytes($res);

Remarks

Use this method to assemble the message and save it to a byte array.

SaveToFile Method (SecureBlackbox_MailWriter Class)

Serializes the message to a file.

Object Oriented Interface

public function doSaveToFile($filename);

Procedural Interface

secureblackbox_mailwriter_do_savetofile($res, $filename);

Remarks

Use this method to assemble the message and save it to a file.

Error Event (SecureBlackbox_MailWriter Class)

Reports information about errors during e-mail message assembling or saving.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_mailwriter_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (SecureBlackbox_MailWriter Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_mailwriter_register_callback($res, 2, array($this, 'fireExternalSign'));

Parameter List

 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

Notification Event (SecureBlackbox_MailWriter Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_mailwriter_register_callback($res, 3, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (MailWriter Class)

The class accepts one or more of the following configuration settings. Configuration 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.

MailWriter Config Settings

Base Config Settings

Trappable Errors (MailWriter Class)

MailWriter Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
	22020097   Failed to assemble a mail message (SB_ERROR_MAIL_ASSEMBLY_FAILED)
	22020098   Failed to parse a mail message (SB_ERROR_MAIL_PARSING_FAILED)
	22020099   Failed to decrypt a message because there is no decryption certificate provided (SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE)