@btonasse/suitescript-types/types/N/email.d.ts

Typings for SuiteScript 2.1

import type { File } from "./file";

interface SendOptions {
    /**
     * Internal ID of the email sender.
     */
    author: number;
    /**
     * The internal ID or email address of the recipient.
     * For multiple recipients, use an array of internal IDs or email addresses. You can use an array that contains a combination of internal IDs and email addresses.
     * A maximum of 10 recipients (recipient + cc + bcc) is allowed.
     * Note: Only the first recipient displays on the Communication tab (under the Recipient column).
     */
    recipients: number | string | number[] | string[] | readonly number[] | readonly string[];
    /**
     * The email address that appears in the reply-to header when an email is sent out.
     */
    replyTo?: string;
    /**
     * The internal ID or email address of the secondary recipient to copy.
     * For multiple recipients, use an array of internal IDs or email addresses. You can use an array that contains a combination of internal IDs and email addresses.
     * A maximum of 10 recipients (recipient + cc + bcc) is allowed.
     */
    cc?: number[] | string[] | readonly number[] | readonly string[];
    /**
     * The internal ID or email address of the secondary recipient to blind copy.
     * For multiple recipients, use an array of internal IDs or email addresses. You can use an array that contains a combination of internal IDs and email addresses.
     * A maximum of 10 recipients (recipient + cc + bcc) is allowed.
     */
    bcc?: number[] | string[] | readonly number[] | readonly string[];
    /**
     * Subject of the outgoing message
     */
    subject: string;
    /**
     * Contents of the email.
     */
    body: string;
    /**
     * The email file attachments.
     * An individual attachment must not exceed 5MB and the total message size must be 15MB or less.
     * Note: Supported for server-side scripts only.
     */
    attachments?: File[] | readonly File[];
    /**
     * Object that contains key/value pairs to associate the Message record with related records (including custom records).
     */
    relatedRecords?: RelatedRecordTypes;
    /**
     * If true, the Message record is not visible to an external Entity (for example, a customer or contact). Default is false.
     */
    isInternalOnly?: boolean;
}

interface RelatedRecordTypes {
    /**
     * The Transaction record(s) attached to the Message record. Use for transaction and opportunity record types.
     */
    transactionId?: number;
    /**
     * The Activity record(s) attached to the Email Message record. Use for Case and Campaign record types.
     */
    activityId?: number;
    /**
     * The Entity record(s) attached to the Email Message record. Use for all Entity record types (for example, customer, contact).
     */
    entityId?: number;
    /**
     * The custom record(s) attached to the Email Message record. For custom records you must specify both the record ID and the record type ID.
     */
    customRecord?: CustomRecordObject;
}

interface CustomRecordObject {
    /**
     * The instance ID for the custom record attached to the Email Message record.
     */
    id: number;
    /**
     * The custom record type attached to the Message record.
     */
    recordType: string;
}

interface SendCampaignOptions {
    /**
     * The internal ID of the campaign event.
     */
    campaignEventId: number;
    /**
     * The internal ID of the recipient.
     */
    recipientId: number;
}

interface EmailSendFunction {
    (options: SendOptions): void;
    promise(options: SendOptions): Promise<void>;
}

interface EmailSendCampaignFunction {
    (options: SendCampaignOptions): number;
    promise(options: SendCampaignOptions): Promise<number>;
}

/**
 * Method used to send transactional email asynchronously and receive bounceback notifications if the email is not successfully delivered.
 */
export const send: EmailSendFunction;
/**
 * This method is used to send bulk email when a bounceback notification is not required.
 */
export const sendBulk: EmailSendFunction;
/**
 * Method used to send a single “on-demand” campaign email to a specified recipient and return a campaign response ID to track the email.
 * Email (campaignemail) sublists are not supported. The campaign must use a Lead Nurturing (campaigndrip) sublist.
 */
export const sendCampaignEvent: EmailSendCampaignFunction;