Skip to main content

Create a new Blueprint

The ZK Email Registry allows you to create email proofs by defining a blueprint. This guide will walk you through the steps to create a new blueprint, ensuring you can set up a new email verification pattern.

Prerequisites

Before starting, you'll need an .EML file. If you don't have one, learn how to obtain it here.

Getting Started​

  1. Log in to the ZK Email Registry using your GitHub account.
  2. Navigate to the blueprint creation page.
  3. Click the "Create Blueprint" button on the top right to begin.

Blueprint Details​

Create Blueprint Step 1

Pattern Name​

Choose a descriptive and clear name that users will see in the registry.

Example: "Google Confirmation Proof"

Circuit Name​

Set a technical name for your circuit, following these rules:

  • Use PascalCase
  • Avoid spaces and special characters
  • Omit file extensions
Example: "GoogleConfirmationProof"

Slug​

Your URL identifier is automatically generated as:

{github-username}/{circuitName}

Test Email Upload​

Upload a .EML file here. This file serves multiple purposes:

  • Powering the AI auto extraction feature
  • Testing your extraction regex

If you need to download an .EML file, you can learn how to do so here.

Description​

Provide a concise yet informative explanation of what your blueprint proves.

Example: "Prove that you received a devcon confirmation email."

Email Details​

Now we will configure the query to find the email for creating the proof and setting the sender domain to be used for DKIM verification.

Create Blueprint Step 2

Email Query​

Specify a Gmail search query to locate relevant emails. You can use any valid Gmail query. More information here.

Example: "from:google.com"

This query is used to search the logged-in user's Gmail inbox to easily find and select the relevant email for generating proofs.

Sender Domain​

Specify the domain used for DKIM verification, which is crucial for email authenticity.

  • Location: Find this in the d= field of the DKIM-Signature header.
  • Format: Enter the domain name without the "@" symbol.
Example: "google.com"

Max Email Header Length​

Define the maximum size for email headers:

  • Must be a multiple of 64 bytes
  • Ensure it's large enough to encompass your entire email header
Example: 1024
caution

Setting this value too low may result in a blueprint compilation error, while setting it too high unnecessarily increases the circuit size.

Skip body hash check​

Enable this option to ignore the email body during proof generation:

  • Useful when extracting data solely from headers
  • Reduces the number of constraints in the circuit
  • Can significantly improve proof generation speed
note

Only enable this if you're certain all required data is in the headers, as it will prevent any body content verification.

Field Extraction​

This section defines the data you want to extract from the email.

Create Blueprint Step 3

AI Auto-extraction​

Leverage AI to simplify the field extraction process:

  • Provide a clear description of the fields you want to extract
  • Click the "Generate Fields" button
  • Review and refine the AI-generated extraction fields as needed

Fields to Extract​

For each data point you wish to extract:

  • Field Name: Assign a clear, descriptive identifier

    Example: "receiverName"

  • Data Location: Specify the email section to search:

    • Body: Main email content
    • Headers: Email metadata (subject, sender, etc.)

  • Max Length: Set the maximum character count for this field

    Example: 64

  • Decomposed Regex Parts: Define your extraction pattern:

    [
      {
        "isPublic": true,
        "regexDef": "[a-zA-Z0-9_]+"  // Matches username
      }
    ]

Learn more about decomposed regex here.

External Inputs​

For any additional data:

  • Field Name: Choose a descriptive identifier (e.g., "eventCode")
  • Maximum Length: Set an appropriate character limit (e.g., 20)

Example Blueprints​