nativescript-toolbox-sw/email/index.d.ts

Fork of nativescript-toolbox - A NativeScript module that is a composition of useful classes, tools and helpers.

declare module "nativescript-email" {

    interface Attachment {
      /**
       * The name used for the attachment.
       * Example:
       * 
       *   fileName: 'Cute-Kitten.png'
       */
      fileName: string;

      /**
       * There are various ways to use the path param:
       * 
       *   - base64 encoded: 'base64://iVBORw..XYZ'
       *   - local app folder 'file://..
       *   - anywhere on the device: 'file:///..'
       *   - or '/some/path/to/file.png'
       */
      path: string;

      /**
       * Used to help the iOS figure out how to send the file (not used on Android).
       * Example:
       * 
       *   mimeType: 'image/png'
       */
      mimeType: string;
    }

    /**
     * The options object passed into the compose function.
     */
    export interface ComposeOptions {
      /**
       * The subject of your email.
       */
      subject?: string;

      /**
       * The plugin will automatically handle plain and html email content.
       */
      body?: string;

      /**
       * A string array of email addresses.
       * Known issue: on Android only the first item in the array is added.
       */
      to?: string[];

      /**
       * A string array of email addresses.
       * Known issue: on Android only the first item in the array is added.
       */
      cc?: string[];

      /**
       * A string array of email addresses.
       * Known issue: on Android only the first item in the array is added.
       */
      bcc?: string[];

      /**
       * An optional Array of attachments.
       */
      attachments?: Array<Attachment>;

      /**
       * On Android the user may have more than one app able to send email with.
       * That will trigger a picker which has a title. You can change the default title here.
       */
      appPickerTitle?: string;
    }

    /**
     * No email client may be available, so test first.
     */
    export function available(): Promise<boolean>;
    /**
     * On iOS the returned boolean indicates whether or not the email was sent by the user.
     * On Android it's always true, unfortunately.
     */
    export function compose(options: ComposeOptions): Promise<boolean>;
}