API Reference: E-Mail

Below are the parameters and return data type references for the methods in TypeScript format.

subscribeNewsletter

subscribeNewsletter(
    params: SubmitEvent | {
        group: number | 'public' | 'authorized' | 'admin' | string; // Custom group is an alphanumeric string (<=20 chars).
        email?: string | string[]; // only for public newsletters
        redirect?: string; // only for public newsletters. User will be redirected to this URL when confirmation link is clicked.
    }
): Promise<string>

unsubscribeNewsletter

unsubscribeNewsletter(
    params: { 
        group: number | 'public' | 'authorized' | 'admin';
    }
): Promise<string>

getNewsletterSubscription

getNewsletterSubscription(
    params: { 
        group?: number | 'public' | 'authorized';
        user_id?: string; // Admin can fetch another user's subscriptions.
    },
    fetchOptions?: FetchOptions
): Promise<{
    active: boolean;
    timestamp: number;
    group: number;
    subscribed_email: string;
}[] | DatabaseResponse<{
    active: boolean;
    timestamp: number;
    group: number;
    subscribed_email: string;
}>>

getNewsletters

getNewsletters(
    params?: {
        /**
         * Search points.
         * 'message_id' and 'subject' value should be string.
         * Others in numbers.
         */
        searchFor: 'message_id' | 'timestamp' | 'read' | 'complaint' | 'bounced' | 'subject';
        value: string | number;
        group: 'public' | 'authorized' | number;
        range?: string | number;
        /**
         * Defaults to '='
         */
        condition?: '>' | '>=' | '=' | '<' | '<=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte';
    },
    fetchOptions?: FetchOptions;
): Promise<DatabaseResponse<Newsletter>>

See FetchOptions

See DatabaseResponse

See Newsletter

sendInquiry

sendInquiry(
    params: {
        name: string;
        email: string;
        subject: string;
        message: string;
    }
): Promise<'SUCCESS: Inquiry has been sent.'>