Versions in this module Expand all Collapse all v0 v0.1.1 Nov 11, 2026 v0.1.0 Oct 15, 2026 Changes in this version + const DefaultDownloadTimeout + const DefaultMaxDownloadBytes + const DefaultMaxResponseBytes + const DefaultPageSize + const DefaultTimeout + const DefaultWaitInterval + const MaxItemsPerPage + const MaxJobRequestBytes + var ErrBudgetExhausted = errors.New("neverbounce: budget exhausted") + var ErrInvalidConfig = errors.New("neverbounce: invalid configuration") + var ErrInvalidRequest = errors.New("neverbounce: invalid request") + var ErrJobFailed = errors.New("neverbounce: job failed") + var ErrMalformedResponse = errors.New("neverbounce: malformed response") + var ErrRateLimited = errors.New("neverbounce: rate limited") + var ErrRejected = errors.New("neverbounce: rejected by provider") + var ErrResponseTooLarge = errors.New("neverbounce: response too large") + var ErrTimeout = errors.New("neverbounce: timeout") + var ErrTransport = errors.New("neverbounce: transport failure") + var ErrUnauthorized = errors.New("neverbounce: unauthorized") + var ErrUnavailable = errors.New("neverbounce: temporarily unavailable") + var ErrUnexpectedResponse = errors.New("neverbounce: unexpected response") + var ErrUnknownJobState = errors.New("neverbounce: unknown job state") + var ErrUpstream = errors.New("neverbounce: provider server error") + var ErrWriteFailed = errors.New("neverbounce: download write failed") + type APIStatus string + const APIStatusAuthFailure + const APIStatusBadReferrer + const APIStatusGeneralFailure + const APIStatusSuccess + const APIStatusTempUnavail + const APIStatusThrottleTriggered + func (s APIStatus) Known() bool + type AddressInfo struct + Addr string + Alias string + Domain string + FQDN string + Host string + NormalizedEmail string + OriginalEmail string + Subdomain string + TLD string + type BinaryFormat string + const BinaryLowerTrueFalse + const BinaryLowerYN + const BinaryLowerYesNo + const BinaryOneZero + const BinaryTitleYesNo + const BinaryUpperYN + type CallError struct + APIStatus APIStatus + BytesWritten int64 + Field string + JobID JobID + Kind FailureKind + Op Operation + Page int + StatusCode int + func (e *CallError) Diagnostics() ProviderDiagnostics + func (e *CallError) Error() string + func (e *CallError) GoString() string + func (e *CallError) Is(target error) bool + func (e *CallError) Unwrap() error + type CheckEmailRequest struct + AddressInfo bool + CreditsInfo bool + Email string + LeverageHistoricalData *bool + Timeout time.Duration + type CheckEmailResult struct + AddressInfo *AddressInfo + CreditsInfo *CreditsInfo + ExecutionTime *int64 + Flags Flags + Result Result + RetryToken string + SuggestedCorrection string + type Client struct + func NewClient(apiKey string, opts ...Option) (*Client, error) + func (c *Client) CheckEmail(ctx context.Context, req CheckEmailRequest) (*CheckEmailResult, error) + func (c *Client) CreateJob(ctx context.Context, req CreateJobRequest) (*CreateJobResult, error) + func (c *Client) DownloadJob(ctx context.Context, req DownloadJobRequest, w io.Writer) (int64, error) + func (c *Client) GoString() string + func (c *Client) JobResultPages(ctx context.Context, req JobResultPagesRequest) iter.Seq2[*JobResultsPage, error] + func (c *Client) JobResults(ctx context.Context, req JobResultsRequest) (*JobResultsPage, error) + func (c *Client) JobStatus(ctx context.Context, req JobStatusRequest) (*JobStatus, error) + func (c *Client) ParseJob(ctx context.Context, req ParseJobRequest) (*ParseJobResult, error) + func (c *Client) StartJob(ctx context.Context, req StartJobRequest) (*StartJobResult, error) + func (c *Client) String() string + func (c *Client) WaitForJob(ctx context.Context, req WaitForJobRequest) (*JobStatus, error) + type CreateJobRequest struct + AllowManualReview bool + AutoParse bool + AutoStart bool + CallbackHeaders map[string]string + CallbackURL string + Filename string + LeverageHistoricalData *bool + RemoteURL string + RunSample bool + Supplied SuppliedList + func (r CreateJobRequest) Format(f fmt.State, verb rune) + func (r CreateJobRequest) GoString() string + func (r CreateJobRequest) String() string + type CreateJobResult struct + ExecutionTime *int64 + JobID JobID + type CreditsInfo struct + FreeCreditsRemaining *int64 + FreeCreditsUsed *int64 + PaidCreditsRemaining *int64 + PaidCreditsUsed *int64 + type DownloadColumns struct + Addr *bool + Alias *bool + BadSyntax *bool + Domain *bool + EmailStatus *bool + EmailStatusInt *bool + FQDN *bool + FreeEmailHost *bool + HasDNSInfo *bool + HasMailServer *bool + Host *bool + MailServerReachable *bool + Network *bool + RoleAccount *bool + Subdomain *bool + TLD *bool + type DownloadJobRequest struct + Append DownloadColumns + BinaryFormat BinaryFormat + JobID JobID + LineFeed LineFeed + Segments DownloadSegments + type DownloadSegments struct + Catchalls *bool + Disposables *bool + IncludeDuplicates *bool + Invalids *bool + OnlyBadSyntax *bool + OnlyDuplicates *bool + Unknowns *bool + Valids *bool + type FailureKind string + const FailureBudgetExhausted + const FailureCanceled + const FailureDeadlineExceeded + const FailureJobFailed + const FailureMalformedResponse + const FailureRateLimited + const FailureRejected + const FailureResponseTooLarge + const FailureTimeout + const FailureTransport + const FailureUnauthorized + const FailureUnavailable + const FailureUnexpectedResponse + const FailureUnknownJobState + const FailureUpstream + const FailureWriteFailed + type Flag string + const FlagAcademicHost + const FlagAcceptsAll + const FlagBadDNS + const FlagBadSyntax + const FlagConnectFails + const FlagContainsAlias + const FlagContainsSubdomain + const FlagDisposableEmail + const FlagFreeEmailHost + const FlagGovernmentHost + const FlagHasDNS + const FlagHasDNSMX + const FlagHistoricalResponse + const FlagInternationalHost + const FlagMilitaryHost + const FlagProfanity + const FlagRoleAccount + const FlagSMTPConnectable + const FlagSpamtrapNetwork + const FlagSpellingMistake + const FlagSquatterHost + const FlagTemporaryDNSError + func (f Flag) Known() bool + type Flags []Flag + func (fs Flags) Has(f Flag) bool + type JobFailureReason string + const JobFailureEmptyFile + const JobFailureFileCorrupt + const JobFailureFileTooLarge + const JobFailureUnknownFileEncoding + func (r JobFailureReason) Known() bool + type JobID int64 + func (id JobID) String() string + type JobResultPagesRequest struct + ItemsPerPage int + JobID JobID + MaxPages int + StartPage int + type JobResultsPage struct + ExecutionTime *int64 + Page int + Results []ResultRow + TotalPages int64 + TotalResults int64 + func (p *JobResultsPage) More() bool + type JobResultsRequest struct + ItemsPerPage int + JobID JobID + Page int + type JobState string + const JobStateComplete + const JobStateFailed + const JobStateParsing + const JobStateQueued + const JobStateRunning + const JobStateUnderReview + const JobStateUploading + const JobStateWaiting + const JobStateWaitingAnalyzed + func (s JobState) InProgress() bool + func (s JobState) Known() bool + func (s JobState) NeedsAction() bool + func (s JobState) Terminal() bool + type JobStatus struct + BounceEstimate *float64 + CreatedAt string + ExecutionTime *int64 + FailureReason JobFailureReason + Filename string + FinishedAt string + ID JobID + PercentComplete *float64 + StartedAt string + State JobState + Totals JobTotals + type JobStatusRequest struct + JobID JobID + type JobTotals struct + BadSyntax *int64 + Billable *int64 + Catchall *int64 + Disposable *int64 + Duplicates *int64 + Invalid *int64 + Processed *int64 + Records *int64 + Unknown *int64 + Valid *int64 + type LineFeed string + const LineFeedCR + const LineFeedCRLF + const LineFeedLF + const LineFeedLFCR + type Operation string + const OpCheckEmail + const OpCreateJob + const OpDownloadJob + const OpJobResults + const OpJobStatus + const OpParseJob + const OpStartJob + type Option func(*options) + func WithDownloadTimeout(d time.Duration) Option + func WithHTTPClient(hc *http.Client) Option + func WithMaxDownloadBytes(n int64) Option + func WithMaxResponseBytes(n int64) Option + func WithProviderDiagnostics() Option + func WithTestBaseURL(rawURL string) Option + func WithTimeout(d time.Duration) Option + type ParseJobRequest struct + AutoStart bool + JobID JobID + type ParseJobResult struct + ExecutionTime *int64 + QueueID string + type ProviderDiagnostics struct + Message string + type Result string + const ResultCatchall + const ResultDisposable + const ResultInvalid + const ResultUnknown + const ResultValid + func (r Result) Known() bool + type ResultRow struct + Data json.RawMessage + Verification RowVerification + func (r ResultRow) Column(name string) (value string, ok bool) + type RowVerification struct + AddressInfo *AddressInfo + Flags Flags + Result Result + SuggestedCorrection string + type StartJobRequest struct + JobID JobID + RunSample bool + type StartJobResult struct + ExecutionTime *int64 + QueueID string + type SuppliedList struct + Columns []string + Rows [][]string + func EmailList(emails ...string) SuppliedList + type ValidationError struct + Err error + Field string + Reason string + func (e *ValidationError) Error() string + func (e *ValidationError) Unwrap() error + type WaitForJobRequest struct + Interval time.Duration + JobID JobID + MaxWait time.Duration