setName('show-outbound') ->setSynopsis('Show diagnostic details about outbound mail.') ->setExamples( '**show-outbound** --id 1 --id 2') ->setArguments( array( array( 'name' => 'id', 'param' => 'id', 'help' => 'Show details about outbound mail with given ID.', 'repeat' => true, ), array( 'name' => 'dump-html', 'help' => pht( 'Dump the HTML body of the mail. You can redirect it to a '. 'file and then open it in a browser.'), ), )); } public function execute(PhutilArgumentParser $args) { $console = PhutilConsole::getConsole(); $ids = $args->getArg('id'); if (!$ids) { throw new PhutilArgumentUsageException( "Use the '--id' flag to specify one or more messages to show."); } $messages = id(new PhabricatorMetaMTAMail())->loadAllWhere( 'id IN (%Ld)', $ids); if ($ids) { $ids = array_fuse($ids); $missing = array_diff_key($ids, $messages); if ($missing) { throw new PhutilArgumentUsageException( 'Some specified messages do not exist: '. implode(', ', array_keys($missing))); } } $last_key = last_key($messages); foreach ($messages as $message_key => $message) { if ($args->getArg('dump-html')) { $html_body = $message->getHTMLBody(); if (strlen($html_body)) { $template = "{$html_body}"; $console->writeOut("%s\n", $html_body); } else { $console->writeErr( "%s\n", pht('(This message has no HTML body.)')); } continue; } $info = array(); $info[] = pht('PROPERTIES'); $info[] = pht('ID: %d', $message->getID()); $info[] = pht('Status: %s', $message->getStatus()); $info[] = pht('Related PHID: %s', $message->getRelatedPHID()); $info[] = pht('Message: %s', $message->getMessage()); $info[] = null; $info[] = pht('PARAMETERS'); $parameters = $message->getParameters(); foreach ($parameters as $key => $value) { if ($key == 'body') { continue; } if ($key == 'html-body') { continue; } if ($key == 'headers') { continue; } if ($key == 'attachments') { continue; } if (!is_scalar($value)) { $value = json_encode($value); } $info[] = pht('%s: %s', $key, $value); } $info[] = null; $info[] = pht('HEADERS'); foreach (idx($parameters, 'headers', array()) as $header) { list($name, $value) = $header; $info[] = "{$name}: {$value}"; } $attachments = idx($parameters, 'attachments'); if ($attachments) { $info[] = null; $info[] = pht('ATTACHMENTS'); foreach ($attachments as $attachment) { $info[] = idx($attachment, 'filename', pht('Unnamed File')); } } $actors = $message->loadAllActors(); $actors = array_select_keys( $actors, array_merge($message->getToPHIDs(), $message->getCcPHIDs())); $info[] = null; $info[] = pht('RECIPIENTS'); foreach ($actors as $actor) { if ($actor->isDeliverable()) { $info[] = ' '.coalesce($actor->getName(), $actor->getPHID()); } else { $info[] = '! '.coalesce($actor->getName(), $actor->getPHID()); } foreach ($actor->getDeliverabilityReasons() as $reason) { $desc = PhabricatorMetaMTAActor::getReasonDescription($reason); $info[] = ' - '.$desc; } } $info[] = null; $info[] = pht('TEXT BODY'); if (strlen($message->getBody())) { $info[] = $message->getBody(); } else { $info[] = pht('(This message has no text body.)'); } $info[] = null; $info[] = pht('HTML BODY'); if (strlen($message->getHTMLBody())) { $info[] = $message->getHTMLBody(); $info[] = null; } else { $info[] = pht('(This message has no HTML body.)'); } $console->writeOut('%s', implode("\n", $info)); if ($message_key != $last_key) { $console->writeOut("\n%s\n\n", str_repeat('-', 80)); } } } }