SOP-010: Inbox Mail Setup
Current Last updated: December 2024| Document Control | |
|---|---|
| SOP ID | SOP-010 |
| Version | 1.0 |
| Status | Active |
| Source | AYCD Zendesk |
Purpose
Configure AYCD Inbox to receive and retrieve email verification codes (OTPs) for automated account creation and verification workflows.
What is Inbox?
┌─────────────────────────────────────────────────────────────────────────────────┐
│ INBOX OVERVIEW │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ AYCD Inbox is an email/SMS interception service that: │
│ │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ • Provides temporary email addresses for account creation │ │
│ │ • Automatically retrieves verification codes (OTPs) │ │
│ │ • Integrates with supported bots via API │ │
│ │ • Supports both Mail and SMS verification │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ HOW IT WORKS: │
│ │
│ Bot creates account │
│ │ │
│ ▼ │
│ ┌─────────────────┐ │
│ │ Uses Inbox │ │
│ │ email address │ │
│ └────────┬────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Site sends │────►│ Inbox receives │ │
│ │ verification │ │ email │ │
│ └─────────────────┘ └────────┬────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────┐ │
│ │ Inbox extracts │ │
│ │ OTP code │ │
│ └────────┬────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────┐ │
│ │ Bot retrieves │ │
│ │ code via API │ │
│ └────────┬────────┘ │
│ │ │
│ ▼ │
│ Account verified! │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Prerequisites
┌─────────────────────────────────────────────────────────────────┐
│ REQUIREMENTS │
├─────────────────────────────────────────────────────────────────┤
│ │
│ Subscriptions: │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ ✓ AYCD Toolbox Subscription │ │
│ │ ✓ Inbox Subscription (Mail and/or SMS) │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ Software: │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ ✓ AYCD Toolbox installed │ │
│ │ ✓ Bot that supports Inbox API │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ Verify subscriptions at: aycd.io/account#billing │
│ │
└─────────────────────────────────────────────────────────────────┘Inbox Mail Setup Flow
┌─────────────────────────────────────────────────────────────────────────────────┐
│ INBOX MAIL SETUP FLOW │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ START │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 1. Go to Inbox Dashboard │ │
│ │ aycd.io/account#inbox │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 2. Copy Inbox API Key │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 3. Configure Catch-All Domain │ │
│ │ (Optional - for own domain) │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 4. Configure Bot with │ │
│ │ Inbox API Key │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 5. Generate email addresses │ │
│ │ (from bot or API) │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────┐ │
│ │ 6. Test OTP retrieval │ │
│ └───────────────┬─────────────────┘ │
│ │ │
│ ▼ │
│ SUCCESS │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Step-by-Step Instructions
Step 1: Access Inbox Dashboard
Navigate to your Inbox dashboard:
- Go to
aycd.io/account - Click Inbox tab
- Or direct link:
aycd.io/account#inbox
┌─────────────────────────────────────────────────────────────────┐
│ AYCD Account Dashboard │
├─────────────────────────────────────────────────────────────────┤
│ │
│ [Billing] [AutoSolve] [AutoSolve AI] [Inbox] [Discord] │
│ ▲ │
│ │ │
│ Click here │
│ │
└─────────────────────────────────────────────────────────────────┘Step 2: Copy Inbox API Key
┌─────────────────────────────────────────────────────────────────┐
│ Inbox Dashboard │
├─────────────────────────────────────────────────────────────────┤
│ │
│ Mail API Key: │
│ ┌───────────────────────────────────────────────────────────┐ │
│ │ mail_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx │ │
│ └───────────────────────────────────────────────────────────┘ │
│ │
│ [Copy API Key] ◄── Click to copy │
│ │
│ Status: Active │
│ Messages this month: 0 / 10000 │
│ │
└─────────────────────────────────────────────────────────────────┘Step 3: Configure Catch-All Domain (Optional)
If you want to use your own domain:
┌─────────────────────────────────────────────────────────────────────────────────┐
│ CATCH-ALL DOMAIN SETUP │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ OPTION A: Use AYCD provided domains (Default) │
│ ───────────────────────────────────────────── │
│ Emails like: random123@aycd-provided-domain.com │
│ No setup required! │
│ │
│ ─────────────────────────────────────────────────────────────────────────────│
│ │
│ OPTION B: Use your own domain │
│ ───────────────────────────────── │
│ │
│ STEP 1: Add your domain in Inbox Dashboard │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ Custom Domain: [ yourdomain.com ] [Add Domain] │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ STEP 2: Configure DNS records at your registrar │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ Type Host Value TTL │ │
│ │ ─────────────────────────────────────────────────────────────────── │ │
│ │ MX @ mx.inbox.aycd.io 3600 │ │
│ │ TXT @ v=spf1 include:aycd.io ~all 3600 │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ STEP 3: Wait for DNS propagation (up to 48 hours) │
│ │
│ STEP 4: Verify domain in Inbox Dashboard │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Step 4: Configure Bot
Add the Inbox API Key to your bot:
┌─────────────────────────────────────────────────────────────────┐
│ [Your Bot] - Inbox Settings │
├─────────────────────────────────────────────────────────────────┤
│ │
│ Email Provider: [ AYCD Inbox ▼ ] │
│ │
│ Inbox API Key: │
│ ┌───────────────────────────────────────────────────────────┐ │
│ │ mail_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx │ │
│ └───────────────────────────────────────────────────────────┘ │
│ │
│ Email Domain: [ @aycd-domain.com ▼ ] │
│ OR │
│ [ @yourdomain.com ▼ ] (if configured) │
│ │
│ [Save] │
│ │
└─────────────────────────────────────────────────────────────────┘Step 5: Email Address Generation
┌─────────────────────────────────────────────────────────────────────────────────┐
│ EMAIL ADDRESS GENERATION │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ METHOD 1: Bot Auto-Generation │
│ ───────────────────────────────── │
│ Most bots automatically generate random email addresses: │
│ │
│ task123abc@inbox-domain.com │
│ random456def@inbox-domain.com │
│ │
│ ─────────────────────────────────────────────────────────────────────────────│
│ │
│ METHOD 2: API Generation (for developers) │
│ ────────────────────────────────────────── │
│ │
│ POST https://api.aycd.io/inbox/v1/email/generate │
│ Headers: { "Authorization": "Bearer mail_xxxxx" } │
│ Body: { "domain": "inbox-domain.com" } │
│ │
│ Response: { "email": "generated123@inbox-domain.com" } │
│ │
│ ─────────────────────────────────────────────────────────────────────────────│
│ │
│ METHOD 3: Catch-All (any address works) │
│ ───────────────────────────────────────── │
│ With catch-all, any email to your domain works: │
│ │
│ anything@yourdomain.com ──► Goes to your Inbox │
│ whatever123@yourdomain.com ──► Goes to your Inbox │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Step 6: OTP Retrieval
┌─────────────────────────────────────────────────────────────────────────────────┐
│ OTP RETRIEVAL FLOW │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ AUTOMATIC (Bot handles everything) │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ Bot creates account ──► Uses Inbox email ──► Site sends code │ │
│ │ │ │ │
│ │ ▼ │ │
│ │ Bot enters code ◄── Bot retrieves code ◄── Inbox receives email │ │
│ │ │ │ │
│ │ ▼ │ │
│ │ Account verified! │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ MANUAL (API call for developers) │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ GET https://api.aycd.io/inbox/v1/email/otp │ │
│ │ Headers: { "Authorization": "Bearer mail_xxxxx" } │ │
│ │ Params: { "email": "user@domain.com", "timeout": 60 } │ │
│ │ │ │
│ │ Response (when received): │ │
│ │ { │ │
│ │ "otp": "123456", │ │
│ │ "subject": "Your verification code", │ │
│ │ "from": "noreply@site.com", │ │
│ │ "received_at": "2024-01-15T10:30:00Z" │ │
│ │ } │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Inbox API Endpoints
┌─────────────────────────────────────────────────────────────────────────────────┐
│ INBOX API REFERENCE │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ Base URL: https://api.aycd.io/inbox/v1 │
│ Authentication: Bearer token (your Mail API Key) │
│ │
│ ENDPOINTS: │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ Generate Email Address │ │
│ │ POST /email/generate │ │
│ │ Body: { "domain": "string" } │ │
│ │ Returns: { "email": "string" } │ │
│ │ │ │
│ │ ─────────────────────────────────────────────────────────────────── │ │
│ │ │ │
│ │ Get OTP Code │ │
│ │ GET /email/otp │ │
│ │ Params: email, timeout (seconds), pattern (regex optional) │ │
│ │ Returns: { "otp": "string", "subject": "string", ... } │ │
│ │ │ │
│ │ ─────────────────────────────────────────────────────────────────── │ │
│ │ │ │
│ │ Get Latest Email │ │
│ │ GET /email/latest │ │
│ │ Params: email, timeout │ │
│ │ Returns: { "subject": "string", "body": "string", ... } │ │
│ │ │ │
│ │ ─────────────────────────────────────────────────────────────────── │ │
│ │ │ │
│ │ List Emails │ │
│ │ GET /email/list │ │
│ │ Params: email, limit │ │
│ │ Returns: [ { email objects } ] │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Supported Bots
┌─────────────────────────────────────────────────────────────────────────────────┐
│ BOTS WITH INBOX MAIL SUPPORT │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ BOT INBOX SETTING LOCATION │
│ ─────────────────────────────────────────────────────────────────────────────│
│ │
│ Cybersole Settings > Account Gen > Email Provider │
│ NSB Settings > Account Gen > AYCD Inbox │
│ Wrath Settings > Generators > Email Service │
│ Dashe Settings > Account Creation > Email │
│ Stellar Settings > Account Generator > Email │
│ Kodai Settings > Account Gen > Email Provider │
│ Prism Settings > Account Generation > AYCD │
│ │
│ Check bot documentation for latest integration details. │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Troubleshooting
┌─────────────────────────────────────────────────────────────────────────────────┐
│ TROUBLESHOOTING │
├─────────────────────────────────────────────────────────────────────────────────┤
│ │
│ ISSUE: OTP not received │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 1. Check email was sent to correct address │ │
│ │ 2. Verify API key is correct and active │ │
│ │ 3. Check subscription status (message limit) │ │
│ │ 4. Increase timeout value (some sites are slow) │ │
│ │ 5. Check if site uses SMS instead of email │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ ISSUE: Custom domain not receiving │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 1. Verify DNS records are correct │ │
│ │ 2. Wait for DNS propagation (up to 48 hours) │ │
│ │ 3. Check domain verification status in dashboard │ │
│ │ 4. Test with online DNS checker tool │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
│ ISSUE: OTP pattern not matching │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ Some sites use non-standard OTP formats. │ │
│ │ Use the pattern parameter with custom regex: │ │
│ │ │ │
│ │ Standard 6-digit: pattern="\d{6}" │ │
│ │ 4-digit PIN: pattern="\d{4}" │ │
│ │ Alphanumeric: pattern="[A-Z0-9]{8}" │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────────┘Verification Checklist
┌─────────────────────────────────────────────────────────────────┐
│ VERIFICATION CHECKLIST │
├─────────────────────────────────────────────────────────────────┤
│ │
│ □ Inbox subscription active │
│ □ Mail API Key copied from dashboard │
│ □ API Key configured in bot │
│ □ (Optional) Custom domain configured and verified │
│ □ Test email received successfully │
│ □ OTP extraction working │
│ │
│ Inbox Mail is ready for automated verification! │
│ │
└─────────────────────────────────────────────────────────────────┘