@verifymail/sdk/README.md

Official JavaScript/TypeScript SDK for VerifyMail email verification API

# Email Verification SDK

Official JavaScript/TypeScript SDK for the Email Verification API.

## Installation

```bash
npm install @verifymail/sdk
```

## Usage

### Basic Setup

```typescript
import { createClient } from '@verifymail/sdk';

// Initialize the client
const emailVerification = createClient({
  apiKey: 'your-api-key',
});
```

### Verify Single Email

```typescript
try {
  const result = await emailVerification.verifySingle('test@example.com');
  console.log('Verification result:', result);
} catch (error) {
  console.error('Verification failed:', error);
}
```

### Bulk Verification

```typescript
// Start bulk verification
const file = fs.readFileSync('emails.csv');
const job = await emailVerification.startBulkVerification(file, {
  name: 'Customer List'
});

// Check status
const status = await emailVerification.getBulkVerificationStatus(job.id);

// Download results
const results = await emailVerification.downloadBulkResults(job.id, 'json');
```

## API Reference

### `verifySingle(email, options)`
Verifies a single email address.

**Parameters:**
- `email`: string - Email address to verify
- `options`: object (optional)
  - `allowDisposable`: boolean - Allow disposable emails (default: false)
  - `validateDNS`: boolean - Perform DNS validation (default: true)
  - `additionalChecks`: string[] - Additional checks to perform
  - `timeout`: number - Request timeout in milliseconds

**Returns:** Promise<VerificationResult>

### Error Handling

The SDK throws the following error types:
- `APIError`: For API response errors
- `ValidationError`: For invalid input parameters

## License
MIT