Interface IMessageExtender

kind

addAttachment

• addAttachment(attachment): IMessageExtender

• Adds a single attachment to the message.

  Parameters

  • attachment: IMessageAttachment

    the item to add

  Returns IMessageExtender

addAttachments

• addAttachments(attachments): IMessageExtender

• Adds all of the provided attachments to the message.

  Parameters

  • attachments: IMessageAttachment[]

    an array of attachments

  Returns IMessageExtender

addCustomField

• addCustomField(key, value): IMessageExtender

• Adds a custom field to the message. Note: This key can not already exist or it will throw an error. Note: The key must not contain a period in it, an error will be thrown.

  Parameters

  • key: string

    the name of the custom field

  • value: any

    the value of this custom field

  Returns IMessageExtender

getMessage

• getMessage(): IMessage

• Gets the resulting message that has been extended at the point of calling it. Note: modifying the returned value will have no effect.

  Returns IMessage