Connectors Reference

Parseur

Extract structured data trapped in your emails. Then send it to your favorite application.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

ListMailbox ()

List mailboxes

ListTable ()

List tables

GetMailboxSchema (string mailboxID)

Get's the item schema of the selected mailbox

GetTableSchema (string tableID)

Get's the item schema of the selected table

 

Triggers:

Name

Summary

NewDocumentExpanded (string mailboxID, NewDocumentExpandedParameterBody body)

New document processed

TemplateNeeded (string mailboxID, TemplateNeededParameterBody body)

Document failed to process

TableProcessed (string tableID, TableProcessedParameterBody body)

Table processed

 

Objects:

Name

Summary

GetMailboxSchemaResponse

 

GetTableSchemaResponse

 

ListMailboxResponseItem

 

ListTableResponseItem

 

NewDocumentExpandedParameterBody

 

NewDocumentExpandedResponse

 

TableProcessedParameterBody

 

TableProcessedResponse

 

TemplateNeededParameterBody

 

TemplateNeededResponse

 

 

Actions:

ListMailbox

Summary: List mailboxes

Description: List all your mailboxes

 

Syntax:

Parseur.ListMailbox ()

 

Returns:

          Type:array of (ListMailboxResponseItem)

 

ListTable

Summary: List tables

Description: List all tables for this mailbox

 

Syntax:

Parseur.ListTable ()

 

Returns:

          Type:array of (ListTableResponseItem)

 

GetMailboxSchema

Summary: Get's the item schema of the selected mailbox

Description: Gets the schema of the selected mailbox

 

Syntax:

Parseur.GetMailboxSchema (string mailboxID)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxID

string

(Select Mailbox)

Select Mailbox you want schema from

True

 

Returns:

          Type:GetMailboxSchemaResponse

 

GetTableSchema

Summary: Get's the item schema of the selected table

Description: Gets the schema of the selected table

 

Syntax:

Parseur.GetTableSchema (string tableID)

 

Parameters:

Name

Type

Summary

Required

Related Action

tableID

string

(Select Table)

Select Table you want schema from

True

 

Returns:

          Type:GetTableSchemaResponse

 

Triggers:

Trigger NewDocumentExpanded

Summary: New document processed

Description: When an email is successfully processed

 

Syntax:

Parseur.NewDocumentExpanded (string mailboxID, NewDocumentExpandedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxID

string

(Identifier of the mailbox to connect to)

Select a Mailbox you want to process documents from

True

ListMailbox

body

NewDocumentExpandedParameterBody

 

 

True

 

Returns:

          Type:NewDocumentExpandedResponse

 

Trigger TemplateNeeded

Summary: Document failed to process

Description: When an email fails to process

 

Syntax:

Parseur.TemplateNeeded (string mailboxID, TemplateNeededParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxID

string

(Identifier of the mailbox to connect to)

Select a Mailbox you want to process documents from

True

ListMailbox

body

TemplateNeededParameterBody

 

 

True

 

Returns:

          Type:TemplateNeededResponse

 

Trigger TableProcessed

Summary: Table processed

Description: When a table is successfully processed

 

Syntax:

Parseur.TableProcessed (string tableID, TableProcessedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

tableID

string

(Identifier of the Table (or List) to connect to)

Select a Table (or List) you want to process rows from

True

ListTable

body

TableProcessedParameterBody

 

 

True

 

Returns:

          Type:TableProcessedResponse

 


 

GetMailboxSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetTableSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ListMailboxResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

ListTableResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer

 

 

name

string

 

 


 

NewDocumentExpandedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

target

string

 

 


 

NewDocumentExpandedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TableProcessedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

target

string

 

 


 

TableProcessedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TemplateNeededParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

target

string

 

 


 

TemplateNeededResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary