mailpit-api 1.3.0 → 1.4.0-alpha

package/dist/{mjs/index.d.ts → index.d.mts}

@@ -1,19 +1,19 @@
 /** Represents a name and email address for a request. */
-export interface MailpitEmailAddressRequest {
+interface MailpitEmailAddressRequest {
     /** Email address */
     Email: string;
     /** Optional name associated with the email address */
     Name?: string;
 }
 /** Represents a name and email address from a response. */
-export interface MailpitEmailAddressResponse {
+interface MailpitEmailAddressResponse {
     /** Email address */
     Address: string;
     /** Name associated with the email address */
     Name: string;
 }
 /** Represents an attachment for a request. */
-export interface MailpitAttachmentRequest {
+interface MailpitAttachmentRequest {
     /** Base64-encoded string for the file content */
     Content: string;
     /** Optional Content-ID (cid) for attachment. If this field is set then the file is attached inline. */
@@ -24,7 +24,7 @@ export interface MailpitAttachmentRequest {
     Filename: string;
 }
 /** Represents an attachment from a response. */
-export interface MailpitAttachmentResponse {
+interface MailpitAttachmentResponse {
     /** Content ID */
     ContentID: string;
     /** Content type */
@@ -37,29 +37,29 @@ export interface MailpitAttachmentResponse {
     Size: number;
 }
 /** Represents information about a Chaos trigger */
-export interface MailpitChaosTrigger {
+interface MailpitChaosTrigger {
     /** SMTP error code to return. The value must range from 400 to 599. */
     ErrorCode: number;
     /** Probability (chance) of triggering the error. The value must range from 0 to 100. */
     Probability: number;
 }
 /** Common request parameters for APIs with a search query */
-export interface MailpitSearchRequest extends MailpitTimeZoneRequest {
+interface MailpitSearchRequest extends MailpitTimeZoneRequest {
     /** {@link https://mailpit.axllent.org/docs/usage/search-filters/ | Search query} */
     query: string;
 }
 /** Common request parameters for APIs with a search query and time zone option */
-export interface MailpitTimeZoneRequest {
+interface MailpitTimeZoneRequest {
     /** {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | Timezone identifier} used only for `before:` & `after:` searches (eg: "Pacific/Auckland"). */
     tz?: string;
 }
 /** Common request parameters for APIs requiring a list of message database IDs */
-export interface MailpitDatabaseIDsRequest {
+interface MailpitDatabaseIDsRequest {
     /** Array of message database IDs */
     IDs?: string[];
 }
 /** Response for the {@link MailpitClient.getInfo | getInfo()} API containing information about the Mailpit instance. */
-export interface MailpitInfoResponse {
+interface MailpitInfoResponse {
     /** Database path */
     Database: string;
     /** Datacase size in bytes */
@@ -96,7 +96,7 @@ export interface MailpitInfoResponse {
     Version: string;
 }
 /** Response for the {@link MailpitClient.getConfiguration| getConfiguraton()} API containing configuration for the Mailpit web UI. */
-export interface MailpitConfigurationResponse {
+interface MailpitConfigurationResponse {
     /** Whether Chaos support is enabled at runtime */
     ChaosEnabled: boolean;
     /** Whether messages with duplicate IDs are ignored */
@@ -121,7 +121,7 @@ export interface MailpitConfigurationResponse {
     SpamAssassin: boolean;
 }
 /** Response for the {@link MailpitClient.getMessageSummary| getMessageSummary()} API containing the summary of a message */
-export interface MailpitMessageSummaryResponse {
+interface MailpitMessageSummaryResponse {
     /** Message Attachmets */
     Attachments: MailpitAttachmentResponse[];
     /** BCC addresses */
@@ -138,6 +138,17 @@ export interface MailpitMessageSummaryResponse {
     ID: string;
     /** Inline message attachements */
     Inline: MailpitEmailAddressResponse[];
+    /** ListUnsubscribe contains a summary of List-Unsubscribe & List-Unsubscribe-Post headers including validation of the link structure */
+    ListUnsubscribe: {
+        /** Validation errors (if any) */
+        Errors: string;
+        /** List-Unsubscrobe header value */
+        Header: string;
+        /** List-Unsubscribe-Post valie (if set) */
+        HeaderPost: string;
+        /** Detected links, maximum one email and one HTTP(S) link  */
+        Links: string[];
+    };
     /** Message ID */
     MessageID: string;
     /** ReplyTo addresses */
@@ -156,7 +167,7 @@ export interface MailpitMessageSummaryResponse {
     To: MailpitEmailAddressResponse[];
 }
 /** Response for the {@link MailpitClient.listMessages| listMessages()} API containing the summary of multiple messages. */
-export interface MailpitMessagesSummaryResponse {
+interface MailpitMessagesSummaryResponse {
     /** Messages */
     messages: {
         /** The number of attachments */
@@ -202,12 +213,12 @@ export interface MailpitMessagesSummaryResponse {
     unread: number;
 }
 /** Response for the {@link MailpitClient.getMessageHeaders | getMessageHeaders()} API containing message headers */
-export interface MailpitMessageHeadersResponse {
+interface MailpitMessageHeadersResponse {
     /** Message headers */
     [key: string]: [string];
 }
 /** Request parameters for the {@link MailpitClient.sendMessage | sendMessage()} API. */
-export interface MailpitSendRequest {
+interface MailpitSendRequest {
     /** Attachments */
     Attachments?: MailpitAttachmentRequest[];
     /** Bcc recipients email addresses only */
@@ -235,12 +246,12 @@ export interface MailpitSendRequest {
     To: MailpitEmailAddressRequest[];
 }
 /** Response for the {@link MailpitClient.sendMessage | sendMessage()} API containing confirmation identifier. */
-export interface MailpitSendMessageConfirmationResponse {
+interface MailpitSendMessageConfirmationResponse {
     /** Confirmation message ID */
     ID: string;
 }
 /** Response from the {@link MailpitClient.htmlCheck | htmlCheck()} API containing HTML check results. */
-export interface MailpitHTMLCheckResponse {
+interface MailpitHTMLCheckResponse {
     /** All platforms tested, mainly for the web UI */
     Platforms: {
         [key: string]: [string];
@@ -308,7 +319,7 @@ export interface MailpitHTMLCheckResponse {
     }[];
 }
 /** Response from the {@link MailpitClient.linkCheck | linkCheck()} API containing link check results. */
-export interface MailpitLinkCheckResponse {
+interface MailpitLinkCheckResponse {
     /** Total number of errors */
     Errors: number;
     /** Tested links */
@@ -322,7 +333,7 @@ export interface MailpitLinkCheckResponse {
     }[];
 }
 /** Response from the {@link MailpitClient.spamAssassinCheck | spamAssassinCheck()} API containing containing SpamAssassin check results. */
-export interface MailpitSpamAssassinResponse {
+interface MailpitSpamAssassinResponse {
     /** If populated will return an error string */
     Errors: number;
     /** Whether the message is spam or not */
@@ -340,7 +351,7 @@ export interface MailpitSpamAssassinResponse {
     Score: number;
 }
 /** Request parameters for the {@link MailpitClient.setReadStatus | setReadStatus()} API. */
-export interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
+interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
     /**
      * Read status
      * @defaultValue false
@@ -350,21 +361,21 @@ export interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
     Search?: string;
 }
 /** Request parameters for the {@link MailpitClient.searchMessages | searchMessages()} API. */
-export interface MailpitSearchMessagesRequest extends MailpitSearchRequest {
+interface MailpitSearchMessagesRequest extends MailpitSearchRequest {
     /** Pagination offset */
     start?: number;
     /** Limit results */
     limit?: number;
 }
 /** Request parameters for the {@link MailpitClient.setTags | setTags()} API. */
-export interface MailpitSetTagsRequest {
+interface MailpitSetTagsRequest {
     /** Array of message database IDs */
     IDs: string[];
     /** Array of tag names to set */
     Tags?: string[];
 }
 /** Request parameters for the {@link MailpitClient.setChaosTriggers | setChaosTriggers()} API. */
-export interface MailpitChaosTriggersRequest {
+interface MailpitChaosTriggersRequest {
     /** Optional Authentication trigger for Chaos */
     Authentication?: MailpitChaosTrigger;
     /** Optional Recipient trigger for Chaos */
@@ -373,7 +384,7 @@ export interface MailpitChaosTriggersRequest {
     Sender?: MailpitChaosTrigger;
 }
 /** Response for the {@link MailpitClient.setChaosTriggers | setChaosTriggers()} and {@link MailpitClient.getChaosTriggers | getChaosTriggers()} APIs containing the current chaos triggers. */
-export interface MailpitChaosTriggersResponse {
+interface MailpitChaosTriggersResponse {
     /** Authentication trigger for Chaos */
     Authentication: MailpitChaosTrigger;
     /** Recipient trigger for Chaos */
@@ -382,7 +393,7 @@ export interface MailpitChaosTriggersResponse {
     Sender: MailpitChaosTrigger;
 }
 /** Response for the {@link MailpitClient.getMessageAttachment |getMessageAttachment()} and {@link MailpitClient.getAttachmentThumbnail | getAttachmentThumbnail()} APIs containing attachment data */
-export interface MailpitAttachmentDataResponse {
+interface MailpitAttachmentDataResponse {
     /** The attachment binary data */
     data: ArrayBuffer;
     /** The attachment MIME type */
@@ -397,7 +408,7 @@ export interface MailpitAttachmentDataResponse {
  * console.log(await mailpit.getInfo());
  * ```
  */
-export declare class MailpitClient {
+declare class MailpitClient {
     private axiosInstance;
     /**
      * Creates an instance of {@link MailpitClient}.
@@ -759,3 +770,5 @@ export declare class MailpitClient {
      */
     renderMessageText(id?: string): Promise<string>;
 }
+
+export { type MailpitAttachmentDataResponse, type MailpitAttachmentRequest, type MailpitAttachmentResponse, type MailpitChaosTrigger, type MailpitChaosTriggersRequest, type MailpitChaosTriggersResponse, MailpitClient, type MailpitConfigurationResponse, type MailpitDatabaseIDsRequest, type MailpitEmailAddressRequest, type MailpitEmailAddressResponse, type MailpitHTMLCheckResponse, type MailpitInfoResponse, type MailpitLinkCheckResponse, type MailpitMessageHeadersResponse, type MailpitMessageSummaryResponse, type MailpitMessagesSummaryResponse, type MailpitReadStatusRequest, type MailpitSearchMessagesRequest, type MailpitSearchRequest, type MailpitSendMessageConfirmationResponse, type MailpitSendRequest, type MailpitSetTagsRequest, type MailpitSpamAssassinResponse, type MailpitTimeZoneRequest };

package/dist/{cjs/index.d.ts → index.d.ts}

@@ -1,19 +1,19 @@
 /** Represents a name and email address for a request. */
-export interface MailpitEmailAddressRequest {
+interface MailpitEmailAddressRequest {
     /** Email address */
     Email: string;
     /** Optional name associated with the email address */
     Name?: string;
 }
 /** Represents a name and email address from a response. */
-export interface MailpitEmailAddressResponse {
+interface MailpitEmailAddressResponse {
     /** Email address */
     Address: string;
     /** Name associated with the email address */
     Name: string;
 }
 /** Represents an attachment for a request. */
-export interface MailpitAttachmentRequest {
+interface MailpitAttachmentRequest {
     /** Base64-encoded string for the file content */
     Content: string;
     /** Optional Content-ID (cid) for attachment. If this field is set then the file is attached inline. */
@@ -24,7 +24,7 @@ export interface MailpitAttachmentRequest {
     Filename: string;
 }
 /** Represents an attachment from a response. */
-export interface MailpitAttachmentResponse {
+interface MailpitAttachmentResponse {
     /** Content ID */
     ContentID: string;
     /** Content type */
@@ -37,29 +37,29 @@ export interface MailpitAttachmentResponse {
     Size: number;
 }
 /** Represents information about a Chaos trigger */
-export interface MailpitChaosTrigger {
+interface MailpitChaosTrigger {
     /** SMTP error code to return. The value must range from 400 to 599. */
     ErrorCode: number;
     /** Probability (chance) of triggering the error. The value must range from 0 to 100. */
     Probability: number;
 }
 /** Common request parameters for APIs with a search query */
-export interface MailpitSearchRequest extends MailpitTimeZoneRequest {
+interface MailpitSearchRequest extends MailpitTimeZoneRequest {
     /** {@link https://mailpit.axllent.org/docs/usage/search-filters/ | Search query} */
     query: string;
 }
 /** Common request parameters for APIs with a search query and time zone option */
-export interface MailpitTimeZoneRequest {
+interface MailpitTimeZoneRequest {
     /** {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | Timezone identifier} used only for `before:` & `after:` searches (eg: "Pacific/Auckland"). */
     tz?: string;
 }
 /** Common request parameters for APIs requiring a list of message database IDs */
-export interface MailpitDatabaseIDsRequest {
+interface MailpitDatabaseIDsRequest {
     /** Array of message database IDs */
     IDs?: string[];
 }
 /** Response for the {@link MailpitClient.getInfo | getInfo()} API containing information about the Mailpit instance. */
-export interface MailpitInfoResponse {
+interface MailpitInfoResponse {
     /** Database path */
     Database: string;
     /** Datacase size in bytes */
@@ -96,7 +96,7 @@ export interface MailpitInfoResponse {
     Version: string;
 }
 /** Response for the {@link MailpitClient.getConfiguration| getConfiguraton()} API containing configuration for the Mailpit web UI. */
-export interface MailpitConfigurationResponse {
+interface MailpitConfigurationResponse {
     /** Whether Chaos support is enabled at runtime */
     ChaosEnabled: boolean;
     /** Whether messages with duplicate IDs are ignored */
@@ -121,7 +121,7 @@ export interface MailpitConfigurationResponse {
     SpamAssassin: boolean;
 }
 /** Response for the {@link MailpitClient.getMessageSummary| getMessageSummary()} API containing the summary of a message */
-export interface MailpitMessageSummaryResponse {
+interface MailpitMessageSummaryResponse {
     /** Message Attachmets */
     Attachments: MailpitAttachmentResponse[];
     /** BCC addresses */
@@ -138,6 +138,17 @@ export interface MailpitMessageSummaryResponse {
     ID: string;
     /** Inline message attachements */
     Inline: MailpitEmailAddressResponse[];
+    /** ListUnsubscribe contains a summary of List-Unsubscribe & List-Unsubscribe-Post headers including validation of the link structure */
+    ListUnsubscribe: {
+        /** Validation errors (if any) */
+        Errors: string;
+        /** List-Unsubscrobe header value */
+        Header: string;
+        /** List-Unsubscribe-Post valie (if set) */
+        HeaderPost: string;
+        /** Detected links, maximum one email and one HTTP(S) link  */
+        Links: string[];
+    };
     /** Message ID */
     MessageID: string;
     /** ReplyTo addresses */
@@ -156,7 +167,7 @@ export interface MailpitMessageSummaryResponse {
     To: MailpitEmailAddressResponse[];
 }
 /** Response for the {@link MailpitClient.listMessages| listMessages()} API containing the summary of multiple messages. */
-export interface MailpitMessagesSummaryResponse {
+interface MailpitMessagesSummaryResponse {
     /** Messages */
     messages: {
         /** The number of attachments */
@@ -202,12 +213,12 @@ export interface MailpitMessagesSummaryResponse {
     unread: number;
 }
 /** Response for the {@link MailpitClient.getMessageHeaders | getMessageHeaders()} API containing message headers */
-export interface MailpitMessageHeadersResponse {
+interface MailpitMessageHeadersResponse {
     /** Message headers */
     [key: string]: [string];
 }
 /** Request parameters for the {@link MailpitClient.sendMessage | sendMessage()} API. */
-export interface MailpitSendRequest {
+interface MailpitSendRequest {
     /** Attachments */
     Attachments?: MailpitAttachmentRequest[];
     /** Bcc recipients email addresses only */
@@ -235,12 +246,12 @@ export interface MailpitSendRequest {
     To: MailpitEmailAddressRequest[];
 }
 /** Response for the {@link MailpitClient.sendMessage | sendMessage()} API containing confirmation identifier. */
-export interface MailpitSendMessageConfirmationResponse {
+interface MailpitSendMessageConfirmationResponse {
     /** Confirmation message ID */
     ID: string;
 }
 /** Response from the {@link MailpitClient.htmlCheck | htmlCheck()} API containing HTML check results. */
-export interface MailpitHTMLCheckResponse {
+interface MailpitHTMLCheckResponse {
     /** All platforms tested, mainly for the web UI */
     Platforms: {
         [key: string]: [string];
@@ -308,7 +319,7 @@ export interface MailpitHTMLCheckResponse {
     }[];
 }
 /** Response from the {@link MailpitClient.linkCheck | linkCheck()} API containing link check results. */
-export interface MailpitLinkCheckResponse {
+interface MailpitLinkCheckResponse {
     /** Total number of errors */
     Errors: number;
     /** Tested links */
@@ -322,7 +333,7 @@ export interface MailpitLinkCheckResponse {
     }[];
 }
 /** Response from the {@link MailpitClient.spamAssassinCheck | spamAssassinCheck()} API containing containing SpamAssassin check results. */
-export interface MailpitSpamAssassinResponse {
+interface MailpitSpamAssassinResponse {
     /** If populated will return an error string */
     Errors: number;
     /** Whether the message is spam or not */
@@ -340,7 +351,7 @@ export interface MailpitSpamAssassinResponse {
     Score: number;
 }
 /** Request parameters for the {@link MailpitClient.setReadStatus | setReadStatus()} API. */
-export interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
+interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
     /**
      * Read status
      * @defaultValue false
@@ -350,21 +361,21 @@ export interface MailpitReadStatusRequest extends MailpitDatabaseIDsRequest {
     Search?: string;
 }
 /** Request parameters for the {@link MailpitClient.searchMessages | searchMessages()} API. */
-export interface MailpitSearchMessagesRequest extends MailpitSearchRequest {
+interface MailpitSearchMessagesRequest extends MailpitSearchRequest {
     /** Pagination offset */
     start?: number;
     /** Limit results */
     limit?: number;
 }
 /** Request parameters for the {@link MailpitClient.setTags | setTags()} API. */
-export interface MailpitSetTagsRequest {
+interface MailpitSetTagsRequest {
     /** Array of message database IDs */
     IDs: string[];
     /** Array of tag names to set */
     Tags?: string[];
 }
 /** Request parameters for the {@link MailpitClient.setChaosTriggers | setChaosTriggers()} API. */
-export interface MailpitChaosTriggersRequest {
+interface MailpitChaosTriggersRequest {
     /** Optional Authentication trigger for Chaos */
     Authentication?: MailpitChaosTrigger;
     /** Optional Recipient trigger for Chaos */
@@ -373,7 +384,7 @@ export interface MailpitChaosTriggersRequest {
     Sender?: MailpitChaosTrigger;
 }
 /** Response for the {@link MailpitClient.setChaosTriggers | setChaosTriggers()} and {@link MailpitClient.getChaosTriggers | getChaosTriggers()} APIs containing the current chaos triggers. */
-export interface MailpitChaosTriggersResponse {
+interface MailpitChaosTriggersResponse {
     /** Authentication trigger for Chaos */
     Authentication: MailpitChaosTrigger;
     /** Recipient trigger for Chaos */
@@ -382,7 +393,7 @@ export interface MailpitChaosTriggersResponse {
     Sender: MailpitChaosTrigger;
 }
 /** Response for the {@link MailpitClient.getMessageAttachment |getMessageAttachment()} and {@link MailpitClient.getAttachmentThumbnail | getAttachmentThumbnail()} APIs containing attachment data */
-export interface MailpitAttachmentDataResponse {
+interface MailpitAttachmentDataResponse {
     /** The attachment binary data */
     data: ArrayBuffer;
     /** The attachment MIME type */
@@ -397,7 +408,7 @@ export interface MailpitAttachmentDataResponse {
  * console.log(await mailpit.getInfo());
  * ```
  */
-export declare class MailpitClient {
+declare class MailpitClient {
     private axiosInstance;
     /**
      * Creates an instance of {@link MailpitClient}.
@@ -759,3 +770,5 @@ export declare class MailpitClient {
      */
     renderMessageText(id?: string): Promise<string>;
 }
+
+export { type MailpitAttachmentDataResponse, type MailpitAttachmentRequest, type MailpitAttachmentResponse, type MailpitChaosTrigger, type MailpitChaosTriggersRequest, type MailpitChaosTriggersResponse, MailpitClient, type MailpitConfigurationResponse, type MailpitDatabaseIDsRequest, type MailpitEmailAddressRequest, type MailpitEmailAddressResponse, type MailpitHTMLCheckResponse, type MailpitInfoResponse, type MailpitLinkCheckResponse, type MailpitMessageHeadersResponse, type MailpitMessageSummaryResponse, type MailpitMessagesSummaryResponse, type MailpitReadStatusRequest, type MailpitSearchMessagesRequest, type MailpitSearchRequest, type MailpitSendMessageConfirmationResponse, type MailpitSendRequest, type MailpitSetTagsRequest, type MailpitSpamAssassinResponse, type MailpitTimeZoneRequest };