smartlead_place_order_mailboxes

Instructions

Implementation Reference

• src/tools/smartSenders.ts:91-149 (schema)

  Primary tool schema definition including name, description, category, and detailed input schema for validating parameters like vendor_id, forwarding_domain, and domains with mailbox_details.

  export const PLACE_ORDER_MAILBOXES_TOOL: CategoryTool = {
    name: 'smartlead_place_order_mailboxes',
    description: 'Confirm and place order for domains and mailboxes to be purchased.',
    category: ToolCategory.SMART_SENDERS,
    inputSchema: {
      type: 'object',
      properties: {
        vendor_id: {
          type: 'integer',
          description: 'ID of the vendor from whom you want to purchase the domains and mailboxes',
        },
        forwarding_domain: {
          type: 'string',
          description: 'The domain to forward to when users access purchased domains',
        },
        domains: {
          type: 'array',
          items: {
            type: 'object',
            properties: {
              domain_name: {
                type: 'string',
                description: 'The domain name you want to purchase',
              },
              mailbox_details: {
                type: 'array',
                items: {
                  type: 'object',
                  properties: {
                    mailbox: {
                      type: 'string',
                      description: 'The complete mailbox address (e.g., john@example.com)',
                    },
                    first_name: {
                      type: 'string',
                      description: 'First name for the mailbox owner',
                    },
                    last_name: {
                      type: 'string',
                      description: 'Last name for the mailbox owner',
                    },
                    profile_pic: {
                      type: 'string',
                      description: 'URL or identifier for profile picture (optional)',
                    },
                  },
                  required: ['mailbox', 'first_name', 'last_name'],
                },
                description: 'Details for each mailbox you want to purchase',
              },
            },
            required: ['domain_name', 'mailbox_details'],
          },
          description: 'List of domains and associated mailbox details for purchase',
        },
      },
      required: ['vendor_id', 'forwarding_domain', 'domains'],
    },
  };

• src/index.ts:231-234 (registration)

  Registers the array of SmartSenders tools (including smartlead_place_order_mailboxes) to the central toolRegistry when the smartSenders category is enabled by feature flags.

  // Register smart senders tools if enabled
  if (enabledCategories.smartSenders) {
    toolRegistry.registerMany(smartSendersTools);
  }

• src/index.ts:360-361 (handler)

  Central request handler dispatches tool calls for SMART_SENDERS category (including smartlead_place_order_mailboxes) to the dedicated handleSmartSendersTool implementation.

  case ToolCategory.SMART_SENDERS:
    return await handleSmartSendersTool(name, toolArgs, apiClient, withRetry);

• src/tools/smartSenders.ts:166-172 (helper)

  Groups the PLACE_ORDER_MAILBOXES_TOOL with other SmartSenders tools in an array for convenient batch registration.

  export const smartSendersTools = [
    GET_VENDORS_TOOL,
    SEARCH_DOMAIN_TOOL,
    AUTO_GENERATE_MAILBOXES_TOOL,
    PLACE_ORDER_MAILBOXES_TOOL,
    GET_DOMAIN_LIST_TOOL,
  ]; 

• src/types/smartSenders.ts:103-120 (schema)

  Type guard function for validating input parameters specific to the place_order_mailboxes tool, ensuring required fields like vendor_id, forwarding_domain, and mailbox details are present.

  export function isPlaceOrderParams(args: unknown): args is PlaceOrderParams {
    if (typeof args !== 'object' || args === null) return false;
    
    const params = args as Partial<PlaceOrderParams>;
    
    // Check if domains have mailbox property in mailbox_details
    const domainsHaveMailboxes = Array.isArray(params.domains) && 
      params.domains.every(domain => 
        isDomainWithMailboxes(domain) && 
        domain.mailbox_details.every(detail => typeof detail.mailbox === 'string')
      );
    
    return (
      typeof params.vendor_id === 'number' &&
      typeof params.forwarding_domain === 'string' &&
      domainsHaveMailboxes
    );
  }