Emails API (1.0)

Download OpenAPI specification:Download

Search over inbound emails

Authorizations:

CognitoUserPool

query Parameters

filter	string Example: filter=createdAfter:2020-08-01,createdBefore:2020-09-01 Filters to apply to records. Available filters are createdAfter, createdBefore, to, subject.
limit	integer [ 1 .. 1000 ] Example: limit=50 Max number of records to return
offset	integer >= 0 Example: offset=100 Used for paging - offset from start
include	string Example: include=Attachment Provide list of extended properties to return
fields	string Example: fields=from,to,subject,id,createdAt,updatedAt List of basic properties to return (* indicates all)
order	string Example: order=-createdAt,subject Sort order for results - hyphen prefix reverses order

Responses

Response samples

200

Content type

application/json

{"Info": {"offset": 10,
"limit": 50,
"count": 67
},
"InboundEmails": [{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
]
}
]
}

Retrieve one inbound email

Authorizations:

CognitoUserPool

path Parameters

emailId

required

integer >= 1

Example: 123

Responses

Response samples

200

Content type

application/json

{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
]
}

Search over outbound emails

Authorizations:

CognitoUserPool

query Parameters

filter	string Example: filter=createdAfter:2020-08-01,createdBefore:2020-09-01 Filters to apply to records
limit	integer [ 1 .. 1000 ] Example: limit=50 Max number of records to return
offset	integer >= 0 Example: offset=100 Used for paging - offset from start
include	string Example: include=Attachment,Event Provide list of extended properties to return
fields	string Example: fields=from,to,subject,body,id,createdAt,updatedAt List of basic properties to return (* indicates all)
order	string Example: order=-createdAt,subject Sort order for results - hyphen prefix reverses order

Responses

Response samples

200

Content type

application/json

{"Info": {"offset": 10,
"limit": 50,
"count": 67
},
"OutboundEmails": [{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"isIgnored": true,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
],
"Events": [{"id": 234,
"type": "processed",
"createdAt": "2020-08-01T03:36:00.000Z"
}
]
}
]
}

Retrieve one outbound email

Authorizations:

CognitoUserPool

path Parameters

emailId

required

integer >= 1

Example: 123

Responses

Response samples

200

Content type

application/json

{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"isIgnored": true,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
],
"Events": [{"id": 234,
"type": "processed",
"createdAt": "2020-08-01T03:36:00.000Z"
}
]
}

Update an Outbound Email

Authorizations:

CognitoUserPool

path Parameters

emailId

required

integer >= 1

Example: 1

ID of the outbound email to update

Request Body schema: application/json

isIgnored

boolean

Responses

Request samples

Payload

Content type

application/json

{"isIgnored": true
}

Response samples

200

Content type

application/json

{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"isIgnored": true,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
],
"Events": [{"id": 234,
"type": "processed",
"createdAt": "2020-08-01T03:36:00.000Z"
}
]
}

Resend an outbound email

Authorizations:

CognitoUserPool

path Parameters

emailId

required

integer >= 1

Example: 123

Request Body schema: application/json

destinationEmail

string

Responses

Request samples

Payload

Content type

application/json

{"destinationEmail": "user@example.com"
}

Response samples

200

Content type

application/json

{"id": 234,
"from": "dbyd@1100.com.au",
"to": "gary@mac.com",
"subject": "This is an email",
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z",
"userId": 123,
"isIgnored": true,
"Attachments": [{"id": 234,
"name": null,
"mimeType": "application/pdf"
}
],
"Events": [{"id": 234,
"type": "processed",
"createdAt": "2020-08-01T03:36:00.000Z"
}
]
}