/**
* List rules functionality
* Uses the Microsoft Graph JS SDK.
*/
const { getGraphClient } = require('../utils/graph-client');
const { formatResponse } = require('../utils/response-formatter');
const { isAuthError, makeErrorResponse, makeResponse } = require('../utils/response-helpers');
/**
* Build structured rows for TOON encoding.
* @param {Array} rules - Raw Graph API rule objects
* @param {boolean} includeDetails - Whether to include conditions/actions
* @returns {Array<object>}
*/
function buildRuleRows(rules, includeDetails) {
const sorted = [...rules].sort((a, b) => (a.sequence || 9999) - (b.sequence || 9999));
return sorted.map((rule, index) => {
const row = {
n: index + 1,
name: rule.displayName,
enabled: rule.isEnabled,
sequence: rule.sequence || null,
};
if (includeDetails) {
row.conditions = formatRuleConditions(rule) || '';
row.actions = formatRuleActions(rule) || '';
}
return row;
});
}
/**
* List rules handler
* @param {object} args - Tool arguments
* @returns {object} - MCP response
*/
async function handleListRules(args) {
const includeDetails = args.includeDetails === true;
try {
const client = await getGraphClient();
// Get all inbox rules
const rules = await getInboxRules(client);
if (!rules || rules.length === 0) {
return makeResponse('No inbox rules found.');
}
const formattedRules = formatRulesList(rules, includeDetails) || 'No inbox rules found.';
const text = formatResponse(
{ rules: buildRuleRows(rules, includeDetails) },
String(formattedRules)
);
return makeResponse(text);
} catch (error) {
if (isAuthError(error)) {
return makeErrorResponse(error.message);
}
return makeErrorResponse(`Error listing rules: ${error.message}`);
}
}
/**
* Get all inbox rules
* Uses direct GET; messageRules typically return in one page.
* @param {object} client - Microsoft Graph SDK client
* @returns {Promise<Array>} - Array of rule objects
*/
async function getInboxRules(client) {
try {
const response = await client.api('me/mailFolders/inbox/messageRules').get();
const value = response && response.value;
return Array.isArray(value) ? value : [];
} catch (error) {
console.error(`Error getting inbox rules: ${error.message}`);
throw error;
}
}
/**
* Format rules list for display
* @param {Array} rules - Array of rule objects
* @param {boolean} includeDetails - Whether to include detailed conditions and actions
* @returns {string} - Formatted rules list
*/
function formatRulesList(rules, includeDetails) {
if (!rules || rules.length === 0) {
return "No inbox rules found.\n\nTip: You can create rules using the 'create-rule' tool. Rules are processed in order of their sequence number (lower numbers are processed first).";
}
// Sort rules by sequence to show execution order
const sortedRules = [...rules].sort((a, b) => {
return (a.sequence || 9999) - (b.sequence || 9999);
});
// Format rules based on detail level
if (includeDetails) {
// Detailed format
const detailedRules = sortedRules.map((rule, index) => {
// Format rule header with sequence
let ruleText = `${index + 1}. ${rule.displayName}${rule.isEnabled ? '' : ' (Disabled)'} - Sequence: ${rule.sequence || 'N/A'}`;
// Format conditions
const conditions = formatRuleConditions(rule);
if (conditions) {
ruleText += `\n Conditions: ${conditions}`;
}
// Format actions
const actions = formatRuleActions(rule);
if (actions) {
ruleText += `\n Actions: ${actions}`;
}
return ruleText;
});
return `Found ${rules.length} inbox rules (sorted by execution order):\n\n${detailedRules.join('\n\n')}\n\nRules are processed in order of their sequence number. You can change rule order using the 'edit-rule-sequence' tool.`;
} else {
// Simple format
const simpleRules = sortedRules.map((rule, index) => {
return `${index + 1}. ${rule.displayName}${rule.isEnabled ? '' : ' (Disabled)'} - Sequence: ${rule.sequence || 'N/A'}`;
});
return `Found ${rules.length} inbox rules (sorted by execution order):\n\n${simpleRules.join('\n')}\n\nTip: Use 'list-rules with includeDetails=true' to see more information about each rule.`;
}
}
/**
* Format rule conditions for display
* @param {object} rule - Rule object
* @returns {string} - Formatted conditions
*/
function formatRuleConditions(rule) {
const conditions = [];
// From addresses
if (rule.conditions?.fromAddresses?.length > 0) {
const senders = rule.conditions.fromAddresses.map(addr => addr.emailAddress.address).join(', ');
conditions.push(`From: ${senders}`);
}
// Subject contains
if (rule.conditions?.subjectContains?.length > 0) {
conditions.push(`Subject contains: "${rule.conditions.subjectContains.join(', ')}"`);
}
// Contains body text
if (rule.conditions?.bodyContains?.length > 0) {
conditions.push(`Body contains: "${rule.conditions.bodyContains.join(', ')}"`);
}
// Has attachment
if (rule.conditions?.hasAttachment === true) {
conditions.push('Has attachment');
}
// Importance
if (rule.conditions?.importance) {
conditions.push(`Importance: ${rule.conditions.importance}`);
}
return conditions.join('; ');
}
/**
* Format rule actions for display
* @param {object} rule - Rule object
* @returns {string} - Formatted actions
*/
function formatRuleActions(rule) {
const actions = [];
// Move to folder
if (rule.actions?.moveToFolder) {
actions.push(`Move to folder: ${rule.actions.moveToFolder}`);
}
// Copy to folder
if (rule.actions?.copyToFolder) {
actions.push(`Copy to folder: ${rule.actions.copyToFolder}`);
}
// Mark as read
if (rule.actions?.markAsRead === true) {
actions.push('Mark as read');
}
// Mark importance
if (rule.actions?.markImportance) {
actions.push(`Mark importance: ${rule.actions.markImportance}`);
}
// Forward
if (rule.actions?.forwardTo?.length > 0) {
const recipients = rule.actions.forwardTo.map(r => r.emailAddress.address).join(', ');
actions.push(`Forward to: ${recipients}`);
}
// Delete
if (rule.actions?.delete === true) {
actions.push('Delete');
}
return actions.join('; ');
}
module.exports = {
handleListRules,
getInboxRules
};
