agentmail 0.5.3 → 0.5.4

package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs

@@ -5,12 +5,14 @@ import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
 import { Email } from "./Email.mjs";
 import { InboxId } from "./InboxId.mjs";
+import { Metadata } from "./Metadata.mjs";
 export const Inbox = core.serialization.object({
     podId: core.serialization.property("pod_id", PodId),
     inboxId: core.serialization.property("inbox_id", InboxId),
     email: Email,
     displayName: core.serialization.property("display_name", DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId.optional()),
+    metadata: Metadata.optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
 });

package/dist/esm/serialization/resources/inboxes/types/Metadata.d.mts

@@ -0,0 +1,8 @@
+import type * as AgentMail from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+import { MetadataValue } from "./MetadataValue.mjs";
+export declare const Metadata: core.serialization.Schema<serializers.inboxes.Metadata.Raw, AgentMail.inboxes.Metadata>;
+export declare namespace Metadata {
+    type Raw = Record<string, MetadataValue.Raw>;
+}

package/dist/esm/serialization/resources/inboxes/types/Metadata.mjs

@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { MetadataValue } from "./MetadataValue.mjs";
+export const Metadata = core.serialization.record(core.serialization.string(), MetadataValue);

package/dist/esm/serialization/resources/inboxes/types/MetadataValue.d.mts

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const MetadataValue: core.serialization.Schema<serializers.inboxes.MetadataValue.Raw, AgentMail.inboxes.MetadataValue>;
+export declare namespace MetadataValue {
+    type Raw = string | number | boolean;
+}

package/dist/esm/serialization/resources/inboxes/types/MetadataValue.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const MetadataValue = core.serialization.undiscriminatedUnion([
+    core.serialization.string(),
+    core.serialization.number(),
+    core.serialization.boolean(),
+]);

package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts

@@ -2,9 +2,11 @@ import type * as AgentMail from "../../../../api/index.mjs";
 import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { Metadata } from "./Metadata.mjs";
 export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
 export declare namespace UpdateInboxRequest {
     interface Raw {
-        display_name: DisplayName.Raw;
+        display_name?: DisplayName.Raw | null;
+        metadata?: Metadata.Raw | null;
     }
 }

package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs

@@ -1,6 +1,8 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { Metadata } from "./Metadata.mjs";
 export const UpdateInboxRequest = core.serialization.object({
-    displayName: core.serialization.property("display_name", DisplayName),
+    displayName: core.serialization.property("display_name", DisplayName.optional()),
+    metadata: Metadata.optional(),
 });

package/dist/esm/serialization/resources/inboxes/types/index.d.mts

@@ -5,4 +5,6 @@ export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
 export * from "./ListInboxesResponse.mjs";
+export * from "./Metadata.mjs";
+export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";

package/dist/esm/serialization/resources/inboxes/types/index.mjs

@@ -5,4 +5,6 @@ export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
 export * from "./ListInboxesResponse.mjs";
+export * from "./Metadata.mjs";
+export * from "./MetadataValue.mjs";
 export * from "./UpdateInboxRequest.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.5.3";
+export declare const SDK_VERSION = "0.5.4";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.5.3";
+export const SDK_VERSION = "0.5.4";

package/dist/llms-full.txt

@@ -5157,8 +5157,6 @@ For more details on scheduled sending—including how to cancel, reschedule, lis
 
 > Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
 
-IMAP support is currently under development and will be available in the coming weeks. The documentation below describes the planned functionality. SMTP is fully available today.
-
 AgentMail supports standard IMAP and SMTP protocols, allowing you to connect using traditional email clients or integrate with existing systems that rely on these protocols.
 
 ## What are IMAP and SMTP?
@@ -5202,9 +5200,15 @@ be rejected. Make sure to enable SSL/TLS in your email client settings.
 | **Password** | Your API key                                    |
 | **SSL/TLS**  | **Required** (must be enabled)                  |
 
-Currently, only the **INBOX** folder is accessible via IMAP. Other folders
-(Sent, Drafts, Trash) are not available through IMAP. Use the [AgentMail
-API](/introduction) for full folder access.
+IMAP exposes the following folders: **INBOX**, **Sent**, **Trash**, and
+**Spam**. A **Drafts** folder is also listed for client compatibility but
+always appears empty — use the [AgentMail API](/introduction) to create
+and manage drafts.
+
+The IMAP server supports the `IDLE` extension (RFC 2177), so modern
+clients (Thunderbird, Outlook, Apple Mail) receive new messages
+push-style without polling. Clients negotiate `IDLE` automatically when
+supported — no extra configuration needed.
 
 ### Python IMAP Example
 
@@ -5224,7 +5228,7 @@ try:
     # Authenticate using inbox email as username
     imap.login(inbox_email, api_key)
 
-    # Select INBOX (only supported folder)
+    # Select a folder (INBOX, Sent, Trash, or Spam)
     imap.select("INBOX")
 
     # Search for all messages
@@ -5278,16 +5282,18 @@ imap.connect();
 
 Use SMTP to send emails from your AgentMail inbox.
 
-SSL/TLS is **required** for all SMTP connections. Connections without SSL will
-be rejected. Make sure to enable SSL/TLS in your email client settings.
+Encryption is **required** for all SMTP connections. Connect using **port 465
+with implicit TLS** (SSL on connect) or **port 587 with STARTTLS** (upgrade
+in-band). On port 587, attempting to authenticate before issuing `STARTTLS`
+is rejected with a `538` error.
 
-| Setting      | Value                          |
-| ------------ | ------------------------------ |
-| **Host**     | `smtp.agentmail.to`            |
-| **Port**     | `465`                          |
-| **Username** | agentmail                      |
-| **Password** | Your API key                   |
-| **SSL/TLS**  | **Required** (must be enabled) |
+| Setting        | Value                                                 |
+| -------------- | ----------------------------------------------------- |
+| **Host**       | `smtp.agentmail.to`                                   |
+| **Port**       | `465` (implicit TLS) or `587` (STARTTLS)              |
+| **Username**   | Your inbox email (e.g., `myinbox@agentmail.to`)       |
+| **Password**   | Your API key                                          |
+| **Encryption** | Port `465`: SSL/TLS on connect · Port `587`: STARTTLS |
 
 The "From" address in your email should match the email address of your inbox
 (e.g., `myinbox@agentmail.to`). Using a different From address may result in
@@ -5318,11 +5324,17 @@ msg["From"] = inbox_email  # Use your inbox email as the From address
 msg["To"] = "recipient@example.com"
 msg.attach(MIMEText("This is a test email sent via SMTP.", "plain"))
 
-# Connect with SSL (required) and send
+# Connect with implicit TLS on port 465 and send
 with smtplib.SMTP_SSL("smtp.agentmail.to", 465) as server:
     server.login(inbox_email, api_key)
     server.send_message(msg)
     print("Email sent successfully!")
+
+# Alternatively, use STARTTLS on port 587:
+#   with smtplib.SMTP("smtp.agentmail.to", 587) as server:
+#       server.starttls()
+#       server.login(inbox_email, api_key)
+#       server.send_message(msg)
 ```
 
 ### TypeScript SMTP Example
@@ -5337,7 +5349,8 @@ const apiKey = process.env.AGENTMAIL_API_KEY!; // From Dashboard → API Keys
 const transporter = nodemailer.createTransport({
   host: "smtp.agentmail.to",
   port: 465,
-  secure: true, // SSL required
+  secure: true, // implicit TLS on port 465
+  // For STARTTLS on port 587 instead, use: port: 587, secure: false
   auth: {
     user: inboxEmail,
     pass: apiKey,
@@ -5359,13 +5372,14 @@ sendEmail().catch(console.error);
 
 ## Troubleshooting
 
-| Error                   | Cause                   | Solution                                               |
-| ----------------------- | ----------------------- | ------------------------------------------------------ |
-| "Authentication failed" | Invalid credentials     | Verify your inbox email and API key from the console   |
-| "Connection refused"    | SSL not enabled         | Enable SSL/TLS in your client settings                 |
-| "Connection timeout"    | Firewall blocking ports | Ensure ports 993 (IMAP) and 465/587 (SMTP) are open    |
-| "Sender not authorized" | Wrong From address      | Use your inbox's email address as the From address     |
-| "Folder not found"      | Non-INBOX folder        | Only INBOX is supported; use the API for other folders |
+| Error                                       | Cause                                  | Solution                                                                                                                                              |
+| ------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| "Authentication failed"                     | Invalid credentials                    | Verify your inbox email and API key from the console                                                                                                  |
+| "Connection refused" / handshake error      | Wrong encryption mode for the port     | Use SSL/TLS on connect for port `465`, or STARTTLS for port `587`                                                                                     |
+| `538` "Must issue a STARTTLS command first" | Plaintext AUTH on port `587`           | Enable STARTTLS on port `587` (or use implicit TLS on `465`) before authenticating                                                                    |
+| "Connection timeout"                        | Firewall blocking ports                | Ensure ports 993 (IMAP) and 465/587 (SMTP) are open                                                                                                   |
+| "Sender not authorized"                     | Wrong From address                     | Use your inbox's email address as the From address                                                                                                    |
+| "Folder not found"                          | Folder name typo or unsupported folder | IMAP exposes `INBOX`, `Sent`, `Trash`, and `Spam`. Folder names other than `INBOX` are case-sensitive. Use the [API](/introduction) to manage drafts. |
 
 ## When to Use IMAP/SMTP vs API
 
@@ -22561,6 +22575,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -22865,6 +22882,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -23183,6 +23203,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -34327,6 +34350,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -34614,6 +34640,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -34915,6 +34944,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -44405,6 +44437,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -44709,6 +44744,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -45027,6 +45065,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.