preview

Creates, updates, deletes, gets or lists a preview resource.

Overview

Name	preview
Type	Resource
Id	cloudflare.email_security.preview

Fields

The following fields are returned by SELECT queries:

list

Email preview

Name	Datatype	Description
screenshot	string	A base64 encoded PNG image of the email.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, investigate_id		Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.
create	insert	account_id, postfix_id		Generates a preview image for a message that was not flagged as a detection. Useful for investigating benign messages. Returns a base64-encoded PNG screenshot of the email body.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
investigate_id	string

SELECT examples

list

Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.

SELECT
screenshot
FROM cloudflare.email_security.preview
WHERE account_id = '{{ account_id }}' -- required
AND investigate_id = '{{ investigate_id }}' -- required
;

INSERT examples

create

Generates a preview image for a message that was not flagged as a detection. Useful for investigating benign messages. Returns a base64-encoded PNG screenshot of the email body.

INSERT INTO cloudflare.email_security.preview (
postfix_id,
account_id
)
SELECT 
'{{ postfix_id }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: preview
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the preview resource.
  - name: postfix_id
    value: "{{ postfix_id }}"
    description: |
      The identifier of the message