smtp.example.json

{
  "name": "Example SMTP Credential",
  "type": "smtp",
  "description": "Template for SMTP (Email) credential configuration in n8n",
  "instructions": [
    "1. In n8n, go to Credentials",
    "2. Click 'New Credential'",
    "3. Select 'SMTP'",
    "4. Fill in fields based on your email provider",
    "5. Click 'Test' to verify configuration",
    "6. Save and note the credential name"
  ],
  "fields": {
    "host": "smtp.gmail.com",
    "port": 587,
    "secure": false,
    "user": "your-email@gmail.com",
    "password": "CONFIGURE_IN_N8N_GUI",
    "fromEmail": "automation@example.com"
  },
  "commonProviders": {
    "gmail": {
      "host": "smtp.gmail.com",
      "port": 587,
      "secure": false,
      "notes": [
        "Use App Password instead of account password",
        "Create at: https://myaccount.google.com/apppasswords",
        "Requires 2FA enabled on Google account",
        "Port 587 = TLS, Port 465 = SSL"
      ]
    },
    "outlook": {
      "host": "smtp-mail.outlook.com",
      "port": 587,
      "secure": false,
      "notes": [
        "Use your Outlook/Hotmail email and password",
        "May require app-specific password",
        "Works with Office 365 accounts"
      ]
    },
    "yahoo": {
      "host": "smtp.mail.yahoo.com",
      "port": 587,
      "secure": false,
      "notes": [
        "Generate app password at Yahoo Account Security",
        "Do not use your regular Yahoo password"
      ]
    },
    "sendgrid": {
      "host": "smtp.sendgrid.net",
      "port": 587,
      "secure": false,
      "user": "apikey",
      "notes": [
        "Username is always 'apikey'",
        "Password is your SendGrid API key",
        "Get API key from SendGrid dashboard",
        "Good for high-volume transactional emails"
      ]
    },
    "mailgun": {
      "host": "smtp.mailgun.org",
      "port": 587,
      "secure": false,
      "notes": [
        "Use SMTP credentials from Mailgun dashboard",
        "Format: postmaster@your-domain.mailgun.org",
        "Good for transactional emails with API tracking"
      ]
    },
    "custom": {
      "host": "smtp.your-server.com",
      "port": 587,
      "secure": false,
      "notes": [
        "Contact your email provider for SMTP settings",
        "Common ports: 587 (TLS), 465 (SSL), 25 (unencrypted)",
        "Use TLS (port 587) for best security"
      ]
    }
  },
  "portConfiguration": {
    "587": {
      "name": "STARTTLS",
      "secure": false,
      "description": "Recommended - Starts unencrypted then upgrades to TLS",
      "recommendation": "Use this for most providers"
    },
    "465": {
      "name": "SSL/TLS",
      "secure": true,
      "description": "Encrypted from the start",
      "recommendation": "Use if provider requires SSL"
    },
    "25": {
      "name": "Unencrypted",
      "secure": false,
      "description": "No encryption - NOT RECOMMENDED",
      "recommendation": "Avoid unless necessary and on private network"
    }
  },
  "testing": {
    "steps": [
      "1. After entering credentials, click 'Test' button in n8n",
      "2. Check the email account for test message",
      "3. If test fails, verify host, port, and credentials",
      "4. Check spam folder if email not in inbox",
      "5. Review error message for specific issues"
    ],
    "commonIssues": {
      "authenticationFailed": "Incorrect username/password or app password required",
      "connectionTimeout": "Firewall blocking SMTP port or incorrect host",
      "tlsError": "Wrong secure setting for the port (try toggling secure option)"
    }
  },
  "bestPractices": [
    "Use app-specific passwords instead of main account passwords",
    "Enable 2FA on email accounts for better security",
    "Use dedicated email account for automation (not personal email)",
    "Monitor sending limits to avoid being flagged as spam",
    "Use reputable SMTP services for production (SendGrid, Mailgun, etc.)",
    "Test credentials regularly to catch expiration/changes",
    "Keep 'fromEmail' domain matching your SMTP provider when possible"
  ],
  "security": {
    "warning": "Never commit actual email passwords to this repository",
    "storage": "Credentials are stored encrypted in n8n's database",
    "appPasswords": "Strongly recommended over regular passwords",
    "rotation": "Rotate app passwords quarterly or when team members leave"
  },
  "limitations": {
    "gmail": "500 emails/day for free accounts, 2000/day for Google Workspace",
    "outlook": "300 emails/day for free accounts",
    "yahoo": "Varies, typically 100-500/day",
    "sendgrid": "100 emails/day free tier, higher on paid plans",
    "note": "For high-volume emails, use dedicated SMTP services"
  },
  "troubleshooting": {
    "testEmailNotReceived": [
      "Check spam/junk folder",
      "Verify 'fromEmail' is valid",
      "Check email provider's sent folder",
      "Review n8n execution logs for errors"
    ],
    "authenticationFailed": [
      "Verify username and password are correct",
      "Generate new app-specific password",
      "Check if 2FA is required",
      "Ensure 'less secure apps' is enabled (if applicable)"
    ],
    "connectionRefused": [
      "Verify SMTP host and port",
      "Check firewall rules",
      "Try different port (587 vs 465)",
      "Test connectivity: telnet smtp.example.com 587"
    ]
  }
}