Get a POP3 pickup source
Returns details of a specific POP3 pickup source including host, port, polling interval, and last run status.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
mailboxId*stringMailbox ULID identifier
pickupId*stringPickup source identifier
Pickup source details
application/json- response
completedAt*|When an import completed, epoch seconds; null while it runs, and always in sync mode. A completed source is disabled and holds no password: re-enabling it needs the password again
int64consecutiveFailures*integerNumber of consecutive failed polling attempts
int64createdAt*integerCreation timestamp in epoch seconds
int64deleteAfterFetch*booleanTrue if messages should be deleted from remote server after fetching
dispatch?|State of the last attempt to hand this source to the fetcher, read from the scheduler. Null when that read was not made (it failed, or the page exceeded the fan-out bound) — never to mean 'nothing happened', which is an object with a null outcome. ABSENT on the operator listing, which is a deliberately DO-free cross-tenant scan
enabled*booleanTrue if automatic polling is enabled
host*stringRemote POP3 server hostname (e.g. 'pop.example.com')
id*stringPickup source ULID
importedTotal?integerMessages this source has stored (replays excluded), counted as they arrive. ABSENT on the operator listing
int64intervalMinutes*integerPolling interval in minutes
int64labelName*|Label (folder) fetched mail files into; null = INBOX. Created on first use if missing. An explicit destination is not spam-scored; a Sieve fileinto still wins; a blocked sender still files to Junk
lastError*|Error message from most recent failed run, or null
lastImportedCount*|Messages the fetcher uploaded on the most recent completed run (its report's uploadedCount). Null until a run has reported; 0 is a run that found nothing waiting
int64lastOversizeCount*|Messages the fetcher left on the remote server on its most recent run because they are over the platform's message size limit; they are never imported and do not hold an import open. Null until a run has reported it
int64lastRunAt*|Timestamp of most recent pickup attempt in epoch seconds, or null
int64lastStatus*|Outcome status of most recent run, or null
"ok""partial""auth_failed""error"mailboxId*stringDestination mailbox ULID where fetched mail is deposited
markRead*booleanTrue if every imported message lands read. False (the default): messages dated before the source was added — the backlog — land read, newer ones unread; POP3 itself carries no read state
mode*stringsync = keep collecting from this account for as long as the source exists. import = move off this account: the source completes itself once a run finds the remote mailbox drained and no new message has been stored for quietDays, then switches off and forgets the remote password
"sync""import"name*|User-assigned label for this remote account (e.g. 'Old Gmail'), or null
port*integerRemote POP3 server port (e.g. 995 for TLS, 110 for STARTTLS)
int64quietDays*integerDays without a newly stored message, after a drained run, that complete an import (1 to 90). Ignored in sync mode
int64quietSince?|When the quiet window last restarted (a message was stored, the source was re-enabled or switched to import), epoch seconds; null = since createdAt. ABSENT on the operator listing
int64tls*stringTransport security mode ('tls' or 'starttls')
"tls""starttls"username*stringRemote POP3 account login username
curl -X GET 'https://api.open.email/api/v1/mailboxes/string/pickups/string'{
"completedAt": 0,
"consecutiveFailures": 0,
"createdAt": 0,
"deleteAfterFetch": true,
"dispatch": {
"consecutiveFailures": 0,
"detail": "string",
"lastAttemptAt": 0,
"nextRunAt": 0,
"outcome": "dispatched"
},
"enabled": true,
"host": "string",
"id": "string",
"importedTotal": 0,
"intervalMinutes": 0,
"labelName": "string",
"lastError": "string",
"lastImportedCount": 0,
"lastOversizeCount": 0,
"lastRunAt": 0,
"lastStatus": "ok",
"mailboxId": "string",
"markRead": true,
"mode": "sync",
"name": "string",
"port": 0,
"quietDays": 0,
"quietSince": 0,
"tls": "tls",
"username": "string"
}