Zip operations

Add folder to zip file

Zips all files and subfolders in a folder into a zip file.

Parameters

Parameter	Description
Path	Path to read files and folders from.
Path to zip file	Zip file to add folder content to.
Password	Optional password to the zip file.
Replace mode	Specifies what to do if a specific file already exists in the archive.
Compression level	Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

Output

Simple value, 'True' if operation was successfully. 'False' otherwise.

Since

6.3

Add single file to zip

Compresses a single file and adds it to a zip file.

Parameters

Parameter	Description
File	File to add to archive.
Path to zip file	Zip file to add file to.
Password	Optional password to the zip file.
Replace mode	Specifies what to do if a specific file already exists in the archive.
Compression level	Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

Output

Simple value, 'True' if operation was successfully. 'False' otherwise.

Since

6.3

Add stream to zip

Compresses the content of a Flow variable that contains a binary stream. This can for instance be used to compress data from a camera input.

Parameters

Parameter	Description
Stream	Stream to read data from.
Filename for stream in zip file	The name of the file in the archive the content of the stream should be written to.
Path to zip file	Zip file to add stream content to.
Password	Optional password to the zip file.
Replace mode	Specifies what to do if a specific file already exists in the archive.
Compression level	Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

Output

Simple value, 'True' if operation was successfully. 'False' otherwise.

Since

6.3

Extract file to stream

Extracts a single file to a stream. The entire file will be loaded into memory, so do not use this operation with large files.

Parameters

Parameter	Description
Path to zip file	Zip file to extract from.
Filename	The name of the file in the archive to extract.
Password	Optional password to the zip file.

Output

Simple value, read-only binary stream trinket.

Since

6.3

Extract files from zip

Extracts all files from a zip file which matches provided mask.

Parameters

Parameter	Description
Path to zip file	Zip file to extract from.
Destination path	Path where to extract files to. If file or directory already exists at destination path, it is skipped (not overwritten). The directory should exist before this operation is called.
Filter	Filet to use when filtering items in archive. Example "*.txt".
Password	Optional password to the zip file.

Output

Simple value, 'True' if operation was successfully. 'False' otherwise.

Since

6.3