Start IMAP polling | Runtype Documentation

Persists IMAP/SMTP configuration on the surface and starts the polling Durable Object.

AuthorizationBearer

API key or Clerk session token

surfaceIdstringRequired

This endpoint expects an object.

fromAddressstringRequiredformat: "email"

imapHoststringRequired>=1 character

imapPasswordstringRequired>=1 character

imapPortintegerRequired1-65535

imapUsernamestringRequired>=1 character

smtpHoststringRequired>=1 character

smtpPasswordstringRequired>=1 character

smtpPortintegerRequired1-65535

smtpUsernamestringRequired>=1 character

fromNamestringOptional

imapSecurebooleanOptional

mailboxstringOptional

pollIntervalMinutesintegerOptional1-60

smtpSecurebooleanOptional

Polling started

successboolean

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/messaging/imap/surfaceId/start \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fromAddress": "notifications@example.com",
>	"imapHost": "imap.example.com",
>	"imapPassword": "SecureP@ssw0rd!",
>	"imapPort": 993,
>	"imapUsername": "user@example.com",
>	"smtpHost": "smtp.example.com",
>	"smtpPassword": "AnotherS3cureP@ss",
>	"smtpPort": 587,
>	"smtpUsername": "user@example.com"
>	}'

$	curl -X POST https://api.runtype.com/v1/messaging/imap/surfaceId/start \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fromAddress": "notifications@example.com",
>	"imapHost": "imap.example.com",
>	"imapPassword": "SecureP@ssw0rd!",
>	"imapPort": 993,
>	"imapUsername": "user@example.com",
>	"smtpHost": "smtp.example.com",
>	"smtpPassword": "AnotherS3cureP@ss",
>	"smtpPort": 587,
>	"smtpUsername": "user@example.com"
>	}'