@memberjunction/communication-gmail 3.3.0 → 4.0.0

package/dist/GmailProvider.d.ts

@@ -0,0 +1,175 @@
+import { BaseCommunicationProvider, CreateDraftParams, CreateDraftResult, ForwardMessageParams, ForwardMessageResult, GetMessagesParams, GetMessagesResult, MessageResult, ProcessedMessage, ProviderCredentialsBase, ReplyToMessageParams, ReplyToMessageResult, ProviderOperation, GetSingleMessageParams, GetSingleMessageResult, DeleteMessageParams, DeleteMessageResult, MoveMessageParams, MoveMessageResult, ListFoldersParams, ListFoldersResult, MarkAsReadParams, MarkAsReadResult, ArchiveMessageParams, ArchiveMessageResult, SearchMessagesParams, SearchMessagesResult, ListAttachmentsParams, ListAttachmentsResult, DownloadAttachmentParams, DownloadAttachmentResult } from "@memberjunction/communication-types";
+/**
+ * Credentials for Gmail provider using OAuth2.
+ * Extend ProviderCredentialsBase to support per-request credential override.
+ *
+ * @remarks
+ * **TEMPORARY INTERFACE**: This interface is part of the interim credential solution for 2.x patch release.
+ * In MemberJunction 3.0, this will be integrated with the comprehensive credential management system.
+ */
+export interface GmailCredentials extends ProviderCredentialsBase {
+    /** Google OAuth2 Client ID */
+    clientId?: string;
+    /** Google OAuth2 Client Secret */
+    clientSecret?: string;
+    /** OAuth2 Redirect URI */
+    redirectUri?: string;
+    /** OAuth2 Refresh Token */
+    refreshToken?: string;
+    /** Service account email (optional) */
+    serviceAccountEmail?: string;
+}
+/**
+ * Implementation of the Gmail provider for sending and receiving messages
+ */
+export declare class GmailProvider extends BaseCommunicationProvider {
+    /** Cached Gmail client for environment credentials */
+    private envGmailClient;
+    /** Cache of Gmail clients for per-request credentials */
+    private clientCache;
+    /**
+     * Resolves credentials by merging request credentials with environment fallback
+     */
+    private resolveCredentials;
+    /**
+     * Creates a Gmail client with the given credentials
+     */
+    private createGmailClient;
+    /**
+     * Gets a Gmail client for the given credentials, using caching for efficiency
+     */
+    private getGmailClient;
+    /**
+     * Gets the authenticated user's email address for a given cached client
+     */
+    private getUserEmail;
+    /**
+     * Encode and format email content for Gmail API
+     */
+    private createEmailContent;
+    /**
+     * Sends a single message using the Gmail API
+     * @param message - The message to send
+     * @param credentials - Optional credentials override for this request.
+     *                      If not provided, uses environment variables.
+     *                      Set `credentials.disableEnvironmentFallback = true` to require explicit credentials.
+     */
+    SendSingleMessage(message: ProcessedMessage, credentials?: GmailCredentials): Promise<MessageResult>;
+    /**
+     * Gets messages from Gmail
+     * @param params - Parameters for fetching messages
+     * @param credentials - Optional credentials override for this request.
+     *                      If not provided, uses environment variables.
+     *                      Set `credentials.disableEnvironmentFallback = true` to require explicit credentials.
+     */
+    GetMessages(params: GetMessagesParams, credentials?: GmailCredentials): Promise<GetMessagesResult>;
+    /**
+     * Reply to a message using Gmail API
+     * @param params - Parameters for replying to a message
+     * @param credentials - Optional credentials override for this request.
+     *                      If not provided, uses environment variables.
+     *                      Set `credentials.disableEnvironmentFallback = true` to require explicit credentials.
+     */
+    ReplyToMessage(params: ReplyToMessageParams, credentials?: GmailCredentials): Promise<ReplyToMessageResult>;
+    /**
+     * Forward a message using Gmail API
+     * @param params - Parameters for forwarding a message
+     * @param credentials - Optional credentials override for this request.
+     *                      If not provided, uses environment variables.
+     *                      Set `credentials.disableEnvironmentFallback = true` to require explicit credentials.
+     */
+    ForwardMessage(params: ForwardMessageParams, credentials?: GmailCredentials): Promise<ForwardMessageResult>;
+    /**
+     * Helper to mark a message as read
+     */
+    private markMessageAsRead;
+    /**
+     * Creates a draft message in Gmail
+     * @param params - Parameters for creating a draft
+     * @param credentials - Optional credentials override for this request.
+     *                      If not provided, uses environment variables.
+     *                      Set `credentials.disableEnvironmentFallback = true` to require explicit credentials.
+     */
+    CreateDraft(params: CreateDraftParams, credentials?: GmailCredentials): Promise<CreateDraftResult>;
+    /**
+     * Returns the list of operations supported by the Gmail provider.
+     * Gmail supports all operations through its label-based system.
+     */
+    getSupportedOperations(): ProviderOperation[];
+    /**
+     * Gets a single message by ID
+     * @param params - Parameters for retrieving the message
+     * @param credentials - Optional credentials override for this request
+     */
+    GetSingleMessage(params: GetSingleMessageParams, credentials?: GmailCredentials): Promise<GetSingleMessageResult>;
+    /**
+     * Deletes a message from Gmail
+     * @param params - Parameters for deleting the message
+     * @param credentials - Optional credentials override for this request
+     */
+    DeleteMessage(params: DeleteMessageParams, credentials?: GmailCredentials): Promise<DeleteMessageResult>;
+    /**
+     * Moves a message to a different label (Gmail's equivalent of folders)
+     * In Gmail, moving is done by adding/removing labels
+     * @param params - Parameters for moving the message
+     * @param credentials - Optional credentials override for this request
+     */
+    MoveMessage(params: MoveMessageParams, credentials?: GmailCredentials): Promise<MoveMessageResult>;
+    /**
+     * Lists Gmail labels (Gmail's equivalent of folders)
+     * @param params - Parameters for listing labels
+     * @param credentials - Optional credentials override for this request
+     */
+    ListFolders(params: ListFoldersParams, credentials?: GmailCredentials): Promise<ListFoldersResult>;
+    /**
+     * Marks messages as read or unread
+     * @param params - Parameters for marking messages
+     * @param credentials - Optional credentials override for this request
+     */
+    MarkAsRead(params: MarkAsReadParams, credentials?: GmailCredentials): Promise<MarkAsReadResult>;
+    /**
+     * Archives a message (removes INBOX label in Gmail)
+     * @param params - Parameters for archiving the message
+     * @param credentials - Optional credentials override for this request
+     */
+    ArchiveMessage(params: ArchiveMessageParams, credentials?: GmailCredentials): Promise<ArchiveMessageResult>;
+    /**
+     * Searches messages using Gmail's search syntax
+     * @param params - Parameters for searching messages
+     * @param credentials - Optional credentials override for this request
+     */
+    SearchMessages(params: SearchMessagesParams, credentials?: GmailCredentials): Promise<SearchMessagesResult>;
+    /**
+     * Lists attachments on a message
+     * @param params - Parameters for listing attachments
+     * @param credentials - Optional credentials override for this request
+     */
+    ListAttachments(params: ListAttachmentsParams, credentials?: GmailCredentials): Promise<ListAttachmentsResult>;
+    /**
+     * Downloads an attachment from a message
+     * @param params - Parameters for downloading the attachment
+     * @param credentials - Optional credentials override for this request
+     */
+    DownloadAttachment(params: DownloadAttachmentParams, credentials?: GmailCredentials): Promise<DownloadAttachmentResult>;
+    /**
+     * Parses a Gmail message into the standard GetMessageMessage format
+     */
+    private parseGmailMessage;
+    /**
+     * Maps Gmail label IDs to system folder types
+     */
+    private mapGmailLabelToSystemFolder;
+    /**
+     * Formats a date for Gmail search query (YYYY/MM/DD)
+     */
+    private formatDateForGmail;
+    /**
+     * Recursively extracts attachment information from message parts
+     */
+    private extractAttachments;
+    /**
+     * Finds attachment info (filename, content type) by attachment ID
+     */
+    private findAttachmentInfo;
+}
+//# sourceMappingURL=GmailProvider.d.ts.map

package/dist/GmailProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GmailProvider.d.ts","sourceRoot":"","sources":["../src/GmailProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EAEpB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EAGpB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EAEjB,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EAErB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,qCAAqC,CAAC;AAM7C;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC/D,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2BAA2B;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAqBD;;GAEG;AACH,qBACa,aAAc,SAAQ,yBAAyB;IAC1D,sDAAsD;IACtD,OAAO,CAAC,cAAc,CAAkC;IAExD,yDAAyD;IACzD,OAAO,CAAC,WAAW,CAA6C;IAEhE;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAyB1B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;OAEG;IACH,OAAO,CAAC,cAAc;IAgCtB;;OAEG;YACW,YAAY;IAsB1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAwD1B;;;;;;OAMG;IACU,iBAAiB,CAC5B,OAAO,EAAE,gBAAgB,EACzB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,aAAa,CAAC;IAqDzB;;;;;;OAMG;IACU,WAAW,CACtB,MAAM,EAAE,iBAAiB,EACzB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAmH7B;;;;;;OAMG;IACU,cAAc,CACzB,MAAM,EAAE,oBAAoB,EAC5B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;IA2DhC;;;;;;OAMG;IACU,cAAc,CACzB,MAAM,EAAE,oBAAoB,EAC5B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;IA+GhC;;OAEG;YACW,iBAAiB;IAgB/B;;;;;;OAMG;IACU,WAAW,CACtB,MAAM,EAAE,iBAAiB,EACzB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAqD7B;;;OAGG;IACa,sBAAsB,IAAI,iBAAiB,EAAE;IAmB7D;;;;OAIG;IACmB,gBAAgB,CACpC,MAAM,EAAE,sBAAsB,EAC9B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;IAmClC;;;;OAIG;IACmB,aAAa,CACjC,MAAM,EAAE,mBAAmB,EAC3B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;OAKG;IACmB,WAAW,CAC/B,MAAM,EAAE,iBAAiB,EACzB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAgD7B;;;;OAIG;IACmB,WAAW,CAC/B,MAAM,EAAE,iBAAiB,EACzB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA2E7B;;;;OAIG;IACmB,UAAU,CAC9B,MAAM,EAAE,gBAAgB,EACxB,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAgC5B;;;;OAIG;IACmB,cAAc,CAClC,MAAM,EAAE,oBAAoB,EAC5B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;IA4BhC;;;;OAIG;IACmB,cAAc,CAClC,MAAM,EAAE,oBAAoB,EAC5B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;IAoEhC;;;;OAIG;IACmB,eAAe,CACnC,MAAM,EAAE,qBAAqB,EAC7B,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,qBAAqB,CAAC;IAoCjC;;;;OAIG;IACmB,kBAAkB,CACtC,MAAM,EAAE,wBAAwB,EAChC,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAyDpC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAqDzB;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAmBnC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAO1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAoB3B"}