Export user data

Export all the Zivver messages that were sent and received by your organization to make them available for archiving purposes. Use a FTP client to transfer the messages from the Zivver platform to a local location.

Connecting via FTP to your Zivver organization is disabled by default. Please contact Support to have it enabled.

Messages are stored as EML files and include any additional attachments. The messages are exported unencrypted, meaning that you do not need a Zivver Client to be able to read them.

In the FTP export the messages are sorted as follows: per account, per month, per conversation, per message. This is an example of how the folder structure looks like:

  • v3
    • Account: johndoe@example.com
      • Month: 202407
        • Conversation: 20240705T120226Z_ee7f2e3j-w51j-642k-yt65-r3fb1233f07w
          • Message:
            • 0001_20240705T120226Z.eml
            • 0002_20240711T091921Z.eml
            • 0003_20240711T092203Z.eml

Requirements

You can use any FTP Client that you prefer as long as it is able to connect to:

  • Host: ftp.zivver.com
  • Encryption: Explicit TLS
  • Port: 21
  • Passive Ports: 60000-60999 (only required when you need to use a Passive Transfer Mode)

How to connect

To connect via FTP to your Zivver organization follow these steps:

  1. Go to Organization Account > Export user data in the Zivver Admin Portal of your Zivver organization.

  2. Copy the Host as shown.

  3. Open your FTP client and fill in the copied host.

  4. Go back to Export user data.

  5. Copy the User name as shown.

  6. Open your FTP client and fill in the copied user name.

  7. Now generate a Zivver API key.

  8. Open your FTP client and fill in the generated API key as the password for the FTP connection.

  9. Make sure that the connection is made via port 21.

  10. Make sure that the connection uses Explicit TLS for encryption.

  11. Make sure that logging is enabled and stored to a local file for further reference.

  12. Test the connection.

FAQ

Error: 530 Authentication failed

When you try to connect and do get a 530 Authentication failed response. This can have multiple causes:

  1. When you try to create a FTP connection for the first time: connecting via FTP to your Zivver organization is probably still disabled by default. Please contact Support to have it enabled.
  2. When you have created a FTP export before, but now suddenly get this error: the API key might be deleted/invalid. The API key is used as a password for the FTP connection. Please check and generate a new one when needed.

Error: The data connection could not be established (ECONNREFUSED)

You can connect via FTP to your Zivver organization, but you can’t transfer any messages. You get an error stating The data connection could not be established: ECONNREFUSED - Connection refused by server.

This problem might occur when the FTP Client is set to use Passive Transfer Mode. However, the FTP connection can’t be made via port range 60000-60999. You might need to allow the FTP Client in your firewall/proxy to reach ftp.zivver.com via this range.

Error: Critical file transfer error

The error Critical file transfer error can be thrown when it is tried to transfer a .eml file, but the file is suddenly missing. This might happen when during a large FTP export, for some messages the revocation date has passed.

Some messages are missing/empty in the conversation folder

If you noticed that some messages are missing in the folder of a specific conversation, this can have different reasons:

  1. The message is revoked. That means that nobody can read the revoked message anymore and thus the message is empty in the FTP export. You notice the word DELETED in the file name of the message.
  2. The message is received by an employee before your organization had its own Zivver organization, and that employee never read the message (again) while having a Zivver account that is part of your organization. This means that the message is still encrypted with the guest (encryption) key. Only when the message is read (again) by the employee while having a Zivver account, the keys are replaced with account (encryption) keys that allows admins of your organization to export those messages via FTP.

Some accounts are missing in the FTP export

If you notice that some accounts are missing in the FTP export, this can have multipe causes:

  1. This account is a guest account and not part of your Zivver organization (yet). Please have a look at how many accounts can be adopted for domains that your organization has claimed.
  2. A master key reset was done, but the missing users did not log in after the reset. Tell those users to log in.

Is the FTP connection secure?

The FTP connection requires explicit TLS. Which means that the FTP Client first connects and then a secure SSL connection is established.

How can the encrypted message be exported unencrypted?

The FTP connection requires you to use a generated API key to make the connection. This API key is used to be able to decrypt the encrypted messages, to allow them to be exported unencrypted.

How large will the FTP export be?

If your FTP Client supports queuing of files, you can queue the complete v3 folder. The FTP Client will then show you how large the files in the queue are.

Was this article helpful?

thumb_up thumb_down