NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Convert-Data Configuration

The cmdlet 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 cmdlet, access to these internal properties is provided through the Config method.

NetCode Configuration Settings

Base64LineBreak:   Tells the cmdlet whether to include line breaks in Base64 encoded content or not.

By default, when encoding to Base64 format, the component will insert line breaks every 76 characters. Setting the Base64LineBreak config to false will cause these line breaks to be omitted from the Base64 encoded content. The default value is true.

HMACAlgorithm:   The hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC).

HMACAlgorithm is used to tell the cmdlet which hashing algorithm to use to generate the Hash-based Message Authentication Code (HMAC). HMACAlgorithm can be "SHA1" (Secure Hash Algorithm 1), "MD5" (Message Digest 5), or one of the SHA-2 algorithms mentioned below. You may truncate the hash output by specifying the desired number of bits. For instance "SHA1-96" and "MD5-96" are acceptable.

The component is capable utilizing the set of HMAC SHA-2 algorithms ("SHA-224", "SHA-256", "SHA-384", and "SHA-512").

The component also supports "RIPEMD160" as an HMAC algorithm.

EncodeHash:   Whether the hash value is hex encoded.

This setting determines whether the MD5, SHA1, or SHA256 hash value is hex encoded. When calling Encode if this setting is True (default) the hash value created will be hex encoded. When set to False the output will not be hex encoded and will be binary. This is only applicable to the following formats:

  • MD5
  • SHA1
  • SHA256

HMACKey:   A key to use when generating a Hash-based Message Authentication Code (HMAC).

When using the Format fmtHMAC, it may be necessary to supply the cmdlet with a key to use when generating the Hash-based Message Authentication Code (HMAC). This key is incorporated into the hashing process to add entropy to the resulting hash code, making the plaintext harder to guess and increasing the message security. You may also set this to a hex value. For instance 0xAAAAAA is acceptable.

MaxFileSize:   When encoding, controls whether encoded data should be split into several files and gives the maximum allowed size for these files.

Some mailing systems require that the message size shouldn't exceed a certain size. Assigning a nonzero value to MaxFileSize makes the cmdlet split the encoded data into several files. FileCnt will contain the number of files created. Please refer to EncodedFile for filename conventions.

The default value for this setting is 0 (no limit).

IMPORTANT: if a non-zero value is assigned to MaxFileSize then a multiple filename should also be assigned to EncodedFile (end with question marks "?") so that the cmdlet can expand the filenames.

Please refer to the Error Messages section for a complete list of possible errors.

UseModifiedUTF7:   Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used.

When Format is set to fmtUTF7, UseModifiedUTF7 is used to tell the cmdlet whether or not to use a modified version of UTF-7 for IMAP mailbox naming. The default value is False.

UseExtendedHexBase32:   Specifies whether or not the Extended Hex alphabet is used.

When Format is set to fmtBase32, UseExtendedHexBase32 is used to tell the cmdlet whether or not to use the Extended Hex alphabet. The default value is False.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6335]