@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.1

package/dist/esm/packages/teams-js/dts/public/mail.d.ts

@@ -1,95 +1,93 @@
 /**
  * Used to interact with mail capability, including opening and composing mail.
  */
-export declare namespace mail {
-    /**
-     * Opens a mail message in the host.
-     *
-     * @param openMailItemParams - Object that specifies the ID of the mail message.
-     */
-    export function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
-    /**
-     * Compose a new email in the user's mailbox.
-     *
-     * @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
-     *
-     */
-    export function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
+/**
+ * Opens a mail message in the host.
+ *
+ * @param openMailItemParams - Object that specifies the ID of the mail message.
+ */
+export declare function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
+/**
+ * Compose a new email in the user's mailbox.
+ *
+ * @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
+ *
+ */
+export declare function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
+/**
+ * Checks if the mail capability is supported by the host
+ * @returns boolean to represent whether the mail capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
+/** Defines the parameters used to open a mail item in the user's mailbox */
+export interface OpenMailItemParams {
+    /** An unique base64-encoded string id that represents the itemId or messageId. */
+    itemId: string;
+}
+/** Defines compose mail types. */
+export declare enum ComposeMailType {
+    /** Compose a new mail message. */
+    New = "new",
+    /** Compose a reply to the sender of an existing mail message. */
+    Reply = "reply",
+    /** Compose a reply to all recipients of an existing mail message. */
+    ReplyAll = "replyAll",
+    /** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
+    Forward = "forward"
+}
+/**
+ * Foundational interface for all other mail compose interfaces
+ * Used for holding the type of mail item being composed
+ *
+ * @typeParam T - the identity type.
+ * @see {@link mail.ComposeMailType}
+ */
+interface ComposeMailBase<T extends ComposeMailType> {
+    /** Type of the mail item being composed. */
+    type: T;
+}
+/**
+ * Parameters supplied when composing a new mail item
+ */
+export interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
     /**
-     * Checks if the mail capability is supported by the host
-     * @returns boolean to represent whether the mail capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * The To: recipients for the message
      */
-    export function isSupported(): boolean;
-    /** Defines the parameters used to open a mail item in the user's mailbox */
-    export interface OpenMailItemParams {
-        /** An unique base64-encoded string id that represents the itemId or messageId. */
-        itemId: string;
-    }
-    /** Defines compose mail types. */
-    export enum ComposeMailType {
-        /** Compose a new mail message. */
-        New = "new",
-        /** Compose a reply to the sender of an existing mail message. */
-        Reply = "reply",
-        /** Compose a reply to all recipients of an existing mail message. */
-        ReplyAll = "replyAll",
-        /** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
-        Forward = "forward"
-    }
+    toRecipients?: string[];
     /**
-     * Foundational interface for all other mail compose interfaces
-     * Used for holding the type of mail item being composed
-     *
-     * @typeParam T - the identity type.
-     * @see {@link mail.ComposeMailType}
+     * The Cc: recipients for the message
      */
-    interface ComposeMailBase<T extends ComposeMailType> {
-        /** Type of the mail item being composed. */
-        type: T;
-    }
+    ccRecipients?: string[];
     /**
-     * Parameters supplied when composing a new mail item
+     * The Bcc: recipients for the message
      */
-    export interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
-        /**
-         * The To: recipients for the message
-         */
-        toRecipients?: string[];
-        /**
-         * The Cc: recipients for the message
-         */
-        ccRecipients?: string[];
-        /**
-         * The Bcc: recipients for the message
-         */
-        bccRecipients?: string[];
-        /**
-         * The subject of the message
-         */
-        subject?: string;
-        /**
-         * The body of the message
-         */
-        message?: string;
-    }
+    bccRecipients?: string[];
     /**
-     * Parameters supplied when composing a reply to or forward of a message
-     *
-     * @see {@link ComposeMailType}
+     * The subject of the message
      */
-    export interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
-        /** An unique base64-encoded string id that represents the mail message. */
-        itemid: string;
-    }
+    subject?: string;
     /**
-     * Parameters supplied to {@link composeMail} when composing a new mail item
-     *
-     * @see {@link ComposeNewParams}
-     * @see {@link ComposeReplyOrForwardParams}
-     * @see {@link ComposeMailType}
+     * The body of the message
      */
-    export type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
-    export {};
+    message?: string;
 }
+/**
+ * Parameters supplied when composing a reply to or forward of a message
+ *
+ * @see {@link ComposeMailType}
+ */
+export interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
+    /** An unique base64-encoded string id that represents the mail message. */
+    itemid: string;
+}
+/**
+ * Parameters supplied to {@link composeMail} when composing a new mail item
+ *
+ * @see {@link ComposeNewParams}
+ * @see {@link ComposeReplyOrForwardParams}
+ * @see {@link ComposeMailType}
+ */
+export type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
+export {};