@labkey/api
    Preparing search index...

    Interface ISendMessageOptions

    interface ISendMessageOptions {
        failure?: RequestFailure<any>;
        msgContent?: string[];
        msgFrom?: string;
        msgRecipients?: string[];
        msgSubject?: string;
        scope?: any;
        success?: RequestSuccess<any>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    failure? msgContent? msgFrom? msgRecipients? msgSubject? scope? success?

    Properties

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    msgContent?: string[]

    An array of content objects which have the following properties:

    • type: the message content type, must be one of the values from: msgType.
    • content: the email message body for this content type.

    The utility function createMsgContent can be used to help create these objects.

    msgFrom?: string

    The email address that appears on the email from line.

    msgRecipients?: string[]

    An array of recipient objects which have the following properties:

    • type: the recipient type, must be one of the values from: recipientType.
    • address: the email address of the recipient.

    The utility function createRecipient can be used to help create these objects. Recipients whose accounts have been deactivated or have never been logged into will be silently dropped from the message.

    msgSubject?: string

    The value that appears on the email subject line.

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    success?: RequestSuccess<any>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties