Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace (Developer Preview)
Level Enum
Method Enum
ZipEntry Class
ZipReader Class
ZipWriter Class
ZipWriter Constructors
ZipWriter Methods
Compression Exceptions
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Developer Preview)
Functions Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ZipWriter Class

Contains methods to add zip entries, generate a zipped archive, and return the result as an Apex blob.

Namespace

Compression

Example

This sample code compresses email attachments into a single file.

1ZipWriter writer = new ZipWriter();
2
3List<id> contentDocumentIds = new List<id>();
4// Add IDs of documents to be compressed to contentDocumentIds 
5
6for ( ContentVersion cv : [SELECT PathOnClient, Versiondata
7  FROM ContentVersion
8  WHERE ContentDocumentId IN :contentDocumentIds]) {
9    writer.addEntry(cv.PathOnClient, cv.versiondata);
10}
11
12blob zipAttachment = writer.getArchive();
13
14Messaging.EmailFileAttachment efa1 = new Messaging.EmailFileAttachment();
15efa.setFileName('attachments.zip');
16efa.setBody(zipAttachment);
17fileAttachments.add(efa);
18
19Messaging.SingleEmailMessage email = new Messaging.SingleEmailMessage();
20// Set all the other email fields, like addresses, subject and body
21
22email.setEntityAttachments(fileAttachments);
23
24Messaging.sendEmail(new Messaging.SingleEmailMessage[] { email });  
25

ZipWriter Constructors

The following are constructors for ZipWriter.

ZipWriter()

Creates a new instance of the ZipWriter class.

Signature

global ZipWriter()

ZipWriter Methods

The following are methods for ZipWriter.

addEntry(name, data)

Adds an entry to the zip file with the specified name and content.

Signature

public Compression.ZipEntry addEntry(string name, blob data)

Parameters

name
Type: string
The name of the zip entry.
name
Type: blob
The content of the zip entry.

Return Value

Type: Compression.ZipEntry

Zip entry added to the zip file.

addEntry(prototype)

Adds a copy of the specified prototype entry to the zip file and includes details such as the zip entry name, comment, last modification time, and content.

Signature

public Compression.ZipEntry addEntry(compression.ZipEntry prototype)

Parameters

prototype
Type: Compression.ZipEntry
Details of the entry to be added to the zip file.

Return Value

Type: Compression.ZipEntry

getArchive()

Compresses the zip entries and generates a ZIP archive.

Signature

public blob getArchive()

Return Value

Type: blob

Apex blob that contains the bytes of the compression operation.

getEntries()

Gets a list of all the entries in the zip file.

Signature

public List<Compression.ZipEntry> getEntries()

Return Value

Type: List<Compression.ZipEntry>

getEntry(name)

Gets the entry with the specified name from the zip file.

Signature

public compression.ZipEntry getEntry(string name)

Parameters

name
Type: string
Name of the zip entry to be retrieved.

Return Value

Type: Compression.ZipEntry

getLevel()

Gets the compression level of the zip file.

Signature

public Compression.Level getLevel()

Return Value

Type: Compression.Level

Uses the Level enum values to indicate the compression level as BEST_COMPRESSION, BEST_SPEED, DEFAULT_LEVEL, or NO_COMPRESSION.

getMethod()

Gets the compression method of the zip file.

Signature

public Compression.Method getMethod()

Return Value

Type: Compression.Method

Uses the Method enum values to indicate the compression method as DEFLATED or STORED.

removeEntry(name)

Removes the entry with the specified name from the zip file.

Signature

public Void removeEntry(string name)

Parameters

name
Type: string
Name of the zip entry to be removed. If an entry with this name isn’t found, the method throws a ZipException exception.

Return Value

Type: Void

setLevel(level)

Sets the compression level of the zip file.

Signature

public Compression.ZipWriter setLevel(compression.Level value)

Parameters

value
Type: Compression.Level
Uses the Level enum to set the compression level.

Return Value

Type: Compression.ZipWriter

Returns the zip file set with the specified compression level.

setMethod(method)

Sets the compression method for the zip file.

Signature

public Compression.ZipWriter setMethod(compression.Method value)

Parameters

value
Type: Compression.Method
Uses the Method enum to set the compression method.

Return Value

Type: Compression.ZipWriter

Returns the zip file set with the specified compression method.