Help
Getting Data In

Connect via IMAP / POP3

Use any email provider with IMAP or POP3 credentials.

IMAP / POP3

If your email provider isn't Gmail or Outlook, you can connect using standard IMAP or POP3 credentials.

Setting up IMAP / POP3

  1. Go to Settings → Email Sources → IMAP / POP3
  2. Fill in:
    • Protocol — IMAP or POP3
    • Host — your mail server (e.g. imap.gmail.com)
    • Port — typically 993 for IMAP over SSL, 995 for POP3 over SSL
    • Encryption — SSL, TLS, or None
    • Username — usually your full email address
    • Password — your email password or an app-specific password
    • Folder — which mailbox folder to scan (default: INBOX)
    • Scan purpose — Receipts, Transaction alerts, or Both
    • Auto-scan — whether the scheduled job picks this up automatically

IMAP vs POP3

IMAP tracks your position using UIDs — Satsuma only ever fetches messages it hasn't seen before. POP3 doesn't support UIDs the same way, so there's a higher chance of re-scanning messages.

IMAP is recommended.

Gmail with IMAP

If you want to connect Gmail over IMAP instead of OAuth, you'll need to generate an App Password in your Google account settings (requires 2-step verification to be enabled). Use that app password instead of your regular Gmail password.

Using OAuth (via "Connect Gmail") is simpler and more secure than IMAP for Gmail.

Auto-scan scheduling

When auto-scan is enabled, the satsuma:scan-emails artisan command picks up this connection on its scheduled run. The exact interval depends on your server's cron configuration.

Related Articles