1 Commits

Author SHA1 Message Date
Sebastian 791825b318 chore(deps): update dependency phpunit/phpunit to v12.5.32
Build Test / test (pull_request) Successful in 37s
JS Unit Tests / test (pull_request) Successful in 32s
PHP Unit Tests / test (pull_request) Successful in 2m14s
PHP Integration Tests / Integration Tests (pull_request) Failing after 2m28s
2026-07-28 03:02:48 +00:00
10 changed files with 196 additions and 529 deletions
Generated
+33 -45
View File
@@ -862,20 +862,20 @@
"packages-dev": [
{
"name": "myclabs/deep-copy",
"version": "1.14.0",
"version": "1.13.4",
"source": {
"type": "git",
"url": "https://github.com/myclabs/DeepCopy.git",
"reference": "8680aa248f8e07bc8fb43f56f0f5fc77a0c96aae"
"reference": "07d290f0c47959fd5eed98c95ee5602db07e0b6a"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/8680aa248f8e07bc8fb43f56f0f5fc77a0c96aae",
"reference": "8680aa248f8e07bc8fb43f56f0f5fc77a0c96aae",
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/07d290f0c47959fd5eed98c95ee5602db07e0b6a",
"reference": "07d290f0c47959fd5eed98c95ee5602db07e0b6a",
"shasum": ""
},
"require": {
"php": "^8.0"
"php": "^7.1 || ^8.0"
},
"conflict": {
"doctrine/collections": "<1.6.8",
@@ -910,15 +910,15 @@
],
"support": {
"issues": "https://github.com/myclabs/DeepCopy/issues",
"source": "https://github.com/myclabs/DeepCopy/tree/1.14.0"
"source": "https://github.com/myclabs/DeepCopy/tree/1.13.4"
},
"funding": [
{
"url": "https://github.com/mnapoli",
"type": "github"
"url": "https://tidelift.com/funding/github/packagist/myclabs/deep-copy",
"type": "tidelift"
}
],
"time": "2026-08-11T10:17:44+00:00"
"time": "2025-08-01T08:46:24+00:00"
},
{
"name": "nikic/php-parser",
@@ -1185,23 +1185,23 @@
},
{
"name": "phpunit/php-file-iterator",
"version": "6.0.2",
"version": "6.0.1",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/php-file-iterator.git",
"reference": "a248d1640ab059b075f53a2ef0f9856e864e06b5"
"reference": "3d1cd096ef6bea4bf2762ba586e35dbd317cbfd5"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/a248d1640ab059b075f53a2ef0f9856e864e06b5",
"reference": "a248d1640ab059b075f53a2ef0f9856e864e06b5",
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/3d1cd096ef6bea4bf2762ba586e35dbd317cbfd5",
"reference": "3d1cd096ef6bea4bf2762ba586e35dbd317cbfd5",
"shasum": ""
},
"require": {
"php": ">=8.3"
},
"require-dev": {
"phpunit/phpunit": "^12.5.33"
"phpunit/phpunit": "^12.0"
},
"type": "library",
"extra": {
@@ -1234,7 +1234,7 @@
"support": {
"issues": "https://github.com/sebastianbergmann/php-file-iterator/issues",
"security": "https://github.com/sebastianbergmann/php-file-iterator/security/policy",
"source": "https://github.com/sebastianbergmann/php-file-iterator/tree/6.0.2"
"source": "https://github.com/sebastianbergmann/php-file-iterator/tree/6.0.1"
},
"funding": [
{
@@ -1254,7 +1254,7 @@
"type": "tidelift"
}
],
"time": "2026-08-25T14:40:53+00:00"
"time": "2026-02-02T14:04:18+00:00"
},
{
"name": "phpunit/php-invoker",
@@ -1442,16 +1442,16 @@
},
{
"name": "phpunit/phpunit",
"version": "12.5.35",
"version": "12.5.32",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "345ac22e42cb14cdc7aa8428655d8bb8c82a4aab"
"reference": "c02591dd7840ed124a98d7770753329ad28e9f8f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/345ac22e42cb14cdc7aa8428655d8bb8c82a4aab",
"reference": "345ac22e42cb14cdc7aa8428655d8bb8c82a4aab",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/c02591dd7840ed124a98d7770753329ad28e9f8f",
"reference": "c02591dd7840ed124a98d7770753329ad28e9f8f",
"shasum": ""
},
"require": {
@@ -1461,18 +1461,18 @@
"ext-libxml": "*",
"ext-mbstring": "*",
"ext-xmlwriter": "*",
"myclabs/deep-copy": "^1.14.0",
"myclabs/deep-copy": "^1.13.4",
"phar-io/manifest": "^2.0.4",
"phar-io/version": "^3.2.1",
"php": ">=8.3",
"phpunit/php-code-coverage": "^12.5.7",
"phpunit/php-file-iterator": "^6.0.2",
"phpunit/php-file-iterator": "^6.0.1",
"phpunit/php-invoker": "^6.0.0",
"phpunit/php-text-template": "^5.0.0",
"phpunit/php-timer": "^8.0.0",
"sebastian/cli-parser": "^4.2.1",
"sebastian/comparator": "^7.1.8",
"sebastian/diff": "^7.0.1",
"sebastian/diff": "^7.0.0",
"sebastian/environment": "^8.1.2",
"sebastian/exporter": "^7.0.3",
"sebastian/global-state": "^8.0.3",
@@ -1520,7 +1520,7 @@
"support": {
"issues": "https://github.com/sebastianbergmann/phpunit/issues",
"security": "https://github.com/sebastianbergmann/phpunit/security/policy",
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.5.35"
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.5.32"
},
"funding": [
{
@@ -1528,7 +1528,7 @@
"type": "other"
}
],
"time": "2026-09-09T04:48:50+00:00"
"time": "2026-07-25T06:54:13+00:00"
},
{
"name": "sebastian/cli-parser",
@@ -1751,24 +1751,24 @@
},
{
"name": "sebastian/diff",
"version": "7.0.1",
"version": "7.0.0",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/diff.git",
"reference": "cd4cabe39f8a4e8ee6818ba99f10a05561ea4ad6"
"reference": "7ab1ea946c012266ca32390913653d844ecd085f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/cd4cabe39f8a4e8ee6818ba99f10a05561ea4ad6",
"reference": "cd4cabe39f8a4e8ee6818ba99f10a05561ea4ad6",
"url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7ab1ea946c012266ca32390913653d844ecd085f",
"reference": "7ab1ea946c012266ca32390913653d844ecd085f",
"shasum": ""
},
"require": {
"php": ">=8.3"
},
"require-dev": {
"phpunit/phpunit": "^12.5.33",
"symfony/process": "^7.4.17"
"phpunit/phpunit": "^12.0",
"symfony/process": "^7.2"
},
"type": "library",
"extra": {
@@ -1806,27 +1806,15 @@
"support": {
"issues": "https://github.com/sebastianbergmann/diff/issues",
"security": "https://github.com/sebastianbergmann/diff/security/policy",
"source": "https://github.com/sebastianbergmann/diff/tree/7.0.1"
"source": "https://github.com/sebastianbergmann/diff/tree/7.0.0"
},
"funding": [
{
"url": "https://github.com/sebastianbergmann",
"type": "github"
},
{
"url": "https://liberapay.com/sebastianbergmann",
"type": "liberapay"
},
{
"url": "https://thanks.dev/u/gh/sebastianbergmann",
"type": "thanks_dev"
},
{
"url": "https://tidelift.com/funding/github/packagist/sebastian/diff",
"type": "tidelift"
}
],
"time": "2026-08-25T15:35:54+00:00"
"time": "2025-02-07T04:55:46+00:00"
},
{
"name": "sebastian/environment",
-27
View File
@@ -1,27 +0,0 @@
<?php
declare(strict_types=1);
namespace KTXM\ProviderJmapc\Listeners;
use KTXC\User\Event\UserCreatedEvent;
use KTXC\User\Event\UserDeletingEvent;
use KTXM\ProviderJmapc\Stores\ServiceStore;
final class UserEventListener
{
public function __construct(
private readonly ServiceStore $serviceStore,
) {
}
public function onUserCreated(UserCreatedEvent $event): void
{
// TODO: implement provisioning configuration
}
public function onUserDeleting(UserDeletingEvent $event): void
{
$this->serviceStore->deleteByUser($event->tenantIdentifier(), $event->userIdentifier());
}
}
+12 -17
View File
@@ -10,15 +10,9 @@ declare(strict_types=1);
namespace KTXM\ProviderJmapc;
use KTXC\Resource\ProviderManager;
use KTXC\User\Event\UserCreatedEvent;
use KTXC\User\Event\UserDeletingEvent;
use KTXF\Event\DeliveryMode;
use KTXF\Event\EventListenerRegistrarInterface;
use KTXF\Module\Configuration\BrowserModuleContextInterface;
use KTXF\Module\Configuration\ModuleContextInterface;
use KTXF\Module\ModuleBrowserInterface;
use KTXF\Module\ModuleInstanceAbstract;
use KTXF\Resource\Provider\ProviderInterface;
use KTXM\ProviderJmapc\Listeners\UserEventListener;
use KTXM\ProviderJmapc\Providers\Mail\Provider as MailProvider;
use KTXM\ProviderJmapc\Providers\Chrono\Provider as ChronoProvider;
use KTXM\ProviderJmapc\Providers\People\Provider as PeopleProvider;
@@ -29,11 +23,10 @@ use KTXM\ProviderJmapc\Providers\Document\Provider as DocumentProvider;
*
* Provides mail, calendar, and contacts services via JMAP protocol.
*/
class Module extends ModuleInstanceAbstract
class Module extends ModuleInstanceAbstract implements ModuleBrowserInterface
{
public function __construct(
private readonly ProviderManager $providerManager,
private readonly EventListenerRegistrarInterface $events,
) {}
public function handle(): string
@@ -74,9 +67,6 @@ class Module extends ModuleInstanceAbstract
public function boot(): void
{
// Register listeners
$this->events->listen($this->handle(), UserCreatedEvent::class, UserEventListener::class, 'onUserCreated', DeliveryMode::Deferred);
$this->events->listen($this->handle(), UserDeletingEvent::class, UserEventListener::class, 'onUserDeleting', DeliveryMode::Deferred);
// Register JMAP providers - all three share the same service store
$this->providerManager->register(ProviderInterface::TYPE_MAIL, 'jmap', MailProvider::class);
//$this->providerManager->register(ProviderInterface::TYPE_CHRONO, 'jmap', ChronoProvider::class);
@@ -84,10 +74,15 @@ class Module extends ModuleInstanceAbstract
$this->providerManager->register(ProviderInterface::TYPE_DOCUMENT, 'jmap', DocumentProvider::class);
}
public function configure(ModuleContextInterface $context): void
{
if ($context instanceof BrowserModuleContextInterface) {
$context->registerModule($this, 'ProviderJmapc', 'static/module.mjs');
}
public function registerBI(): array {
return [
'handle' => $this->handle(),
'namespace' => 'ProviderJmapc',
'version' => $this->version(),
'label' => $this->label(),
'author' => $this->author(),
'description' => $this->description(),
'boot' => 'static/module.mjs',
];
}
}
-59
View File
@@ -9,7 +9,6 @@ declare(strict_types=1);
namespace KTXM\ProviderJmapc\Providers\Mail;
use KTXF\Mail\Object\Address;
use KTXF\Mail\Provider\ProviderBaseInterface;
use KTXF\Mail\Provider\ProviderServiceDiscoverInterface;
use KTXF\Mail\Provider\ProviderServiceMutateInterface;
@@ -143,66 +142,9 @@ class Provider implements ProviderBaseInterface, ProviderServiceMutateInterface,
}
$created = $this->serviceStore->create($tenantId, $userId, $service);
$this->serviceIdentitiesSync($tenantId, $userId, (new Service())->fromStore($created));
return (string) $created['sid'];
}
/**
* Fetches sending identities from the JMAP server and overwrites
* primaryAddress/secondaryAddresses on the service with them.
*/
private function serviceIdentitiesSync(string $tenantId, string $userId, Service $service): void
{
try {
$client = RemoteService::freshClient($service);
$identities = RemoteService::mailService($client)->identityFetch();
// A JMAP server may expose multiple identities sharing the same
// address (e.g. distinct signatures/display names for one
// mailbox) — collapse those down to one entry per address,
// keeping the first label seen.
$addresses = [];
foreach ($identities as $identity) {
if ($identity->address() === null) {
continue;
}
$key = strtolower($identity->address());
if (!isset($addresses[$key])) {
$addresses[$key] = Address::fromArray(['address' => $identity->address(), 'label' => $identity->name()]);
}
}
$addresses = array_values($addresses);
if (empty($addresses)) {
return;
}
$currentAddress = strtolower($service->getPrimaryAddress()->getAddress());
$primaryIndex = 0;
foreach ($addresses as $index => $address) {
if (strtolower($address->getAddress()) === $currentAddress) {
$primaryIndex = $index;
break;
}
}
$secondary = [];
foreach ($addresses as $index => $address) {
if ($index !== $primaryIndex) {
$secondary[] = $address;
}
}
$service->setPrimaryAddress($addresses[$primaryIndex]);
$service->setSecondaryAddresses($secondary);
$this->serviceStore->modify($tenantId, $userId, $service);
} catch (\Throwable) {
// Server may not support urn:ietf:params:jmap:submission, or have
// no identities configured — fall back to what the user entered.
}
}
public function serviceModify(string $tenantId, string $userId, ResourceServiceMutateInterface $service): string
{
if (!($service instanceof Service)) {
@@ -210,7 +152,6 @@ class Provider implements ProviderBaseInterface, ProviderServiceMutateInterface,
}
$this->serviceStore->modify($tenantId, $userId, $service);
$this->serviceIdentitiesSync($tenantId, $userId, $service);
return (string) $service->identifier();
}
+29 -141
View File
@@ -102,8 +102,8 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
],
self::CAPABILITY_ENTITY_FETCH => true,
self::CAPABILITY_ENTITY_EXTANT => true,
self::CAPABILITY_ENTITY_CREATE => true,
self::CAPABILITY_ENTITY_MODIFY => true,
self::CAPABILITY_ENTITY_CREATE => false,
self::CAPABILITY_ENTITY_MODIFY => false,
self::CAPABILITY_ENTITY_PATCH => true,
self::CAPABILITY_ENTITY_DELETE => true,
self::CAPABILITY_ENTITY_MOVE => true,
@@ -206,9 +206,8 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
if (isset($data[self::PROPERTY_IDENTITY])) {
$this->setIdentity($this->freshIdentity(null, $data[self::PROPERTY_IDENTITY]));
}
if (isset($data[self::PROPERTY_PRIMARY_ADDRESS])) {
$value = $data[self::PROPERTY_PRIMARY_ADDRESS];
$this->setPrimaryAddress(is_array($value) ? Address::fromArray($value) : new Address((string)$value));
if (isset($data[self::PROPERTY_PRIMARY_ADDRESS]) && is_string($data[self::PROPERTY_PRIMARY_ADDRESS])) {
$this->setPrimaryAddress(new Address($data[self::PROPERTY_PRIMARY_ADDRESS]));
}
if (isset($data[self::PROPERTY_SECONDARY_ADDRESSES]) && is_array($data[self::PROPERTY_SECONDARY_ADDRESSES])) {
$this->setSecondaryAddresses(array_map(
@@ -484,34 +483,17 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
}
}
if ($deleteMode === 'soft') {
$targetMailbox = $this->mailService->collectionFetch((string) $target->collection());
if ($targetMailbox === null) {
throw new \RuntimeException('Collection not found for delete operation');
}
$targetIdentifier = (string) $target->collection();
$trashIdentifier = (string) $deleteTargetIdentifier->collection();
$parentIdentifier = isset($targetMailbox['parentId'])
? (string) $targetMailbox['parentId']
: null;
// JMAP mailbox IDs are opaque, so containment must be determined
// from parentId rather than by comparing ID prefixes.
if ($targetIdentifier === $trashIdentifier || $parentIdentifier === $trashIdentifier) {
$deleteMode = 'hard';
}
// we need to determine if the folder being deleted is already in the trash
if (str_starts_with((string) $target->collection(), (string) $deleteTargetIdentifier?->collection())) {
// if so, we should hard delete instead of moving to avoid duplicates in the trash
$deleteMode = 'hard';
}
if ($deleteMode === 'soft') {
return $this->collectionMove($deleteTargetIdentifier, $target);
}
if ($this->mailService->collectionDestroy((string) $target->collection(), $force) === null) {
throw new \RuntimeException("Failed to delete collection: {$target->collection()}");
}
return true;
$result = match ($deleteMode) {
'soft' => $this->collectionMove($deleteTargetIdentifier, $target),
'hard' => $this->mailService->collectionDestroy($target->collection(), $force),
};
return $result;
}
public function collectionMove(CollectionIdentifier $target, CollectionIdentifier $source): CollectionBaseInterface
@@ -638,42 +620,14 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
public function entityCreate(CollectionIdentifier $target, MessagePropertiesMutableInterface $properties, array $options = []): EntityResource
{
if ($target->provider() !== $this->provider() || (string)$target->service() !== (string)$this->identifier()) {
throw new \InvalidArgumentException('Target collection does not belong to this service: ' . (string)$target);
}
$this->initialize();
[$nativeMessage, $nativeAttachments] = $this->messagePayload($properties);
$created = $this->mailService->entityCreate((string)$target->collection(), $nativeMessage, $nativeAttachments);
if ($created === null || !isset($created['id'])) {
throw new \RuntimeException('JMAP entity creation did not return an identifier');
}
$created['mailboxIds'] ??= [(string)$target->collection() => true];
return $this->entityFresh()->fromJmap($created);
// TODO: Implement entity create
return $this->entityFresh();
}
public function entityModify(EntityIdentifier $target, MessagePropertiesMutableInterface $properties): EntityResource
public function entityModify(EntityIdentifier $identifier, MessagePropertiesMutableInterface $properties): EntityResource
{
if ($target->provider() !== $this->provider() || (string)$target->service() !== (string)$this->identifier()) {
throw new \InvalidArgumentException('Target collection does not belong to this service: ' . (string)$target);
}
$this->initialize();
[$nativeMessage, $nativeAttachments] = $this->messagePayload($properties);
$nativeMessage['id'] = (string)$target->entity();
$nativeMessage['mailboxIds'] = [(string)$target->collection() => true];
// JMAP replaces immutable Email content and returns the new authoritative ID.
$modified = $this->mailService->entityReplace($nativeMessage, $nativeAttachments);
if ($modified === null) {
throw new \RuntimeException('JMAP entity modification failed');
}
return $this->entityFresh()->fromJmap($modified);
// TODO: Implement entity modify
return $this->entityFresh();
}
public function entityPatch(MessagePropertiesMutableInterface $properties, EntityIdentifier ...$targets): array
@@ -925,14 +879,8 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
);
}
[$nativeMessage, $nativeAttachments] = $this->messagePayload($message);
$transportId = $this->mailService->entitySubmitFresh(
$identityId,
$nativeMessage,
$preSendTarget->collection(),
$postSentTarget->collection(),
$nativeAttachments,
);
$nativeMessage = $this->normalizeMessageProperties($message)->toJmap();
$transportId = $this->mailService->entitySubmitFresh($identityId, $nativeMessage, $preSendTarget->collection(), $postSentTarget->collection());
return new EntitySubmitResult(
EntitySubmitResult::DISPOSITION_SENT,
@@ -950,38 +898,12 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
);
}
// determine the sent folder
// if no explicit sent folder is configured, we will attempt to find a folder with the "sent" role.
$postSentTarget = $this->auxiliary['sentTarget'] ?? null;
$postSentTarget = $postSentTarget !== null && (string) $postSentTarget !== ''
? new CollectionIdentifier($this->provider(), (string) $this->identifier(), (string) $postSentTarget)
: $this->resolveCollectionByRole(CollectionRoles::Sent->value);
if ($postSentTarget === null
|| $postSentTarget->provider() !== $this->provider()
|| $postSentTarget->service() !== (string)$this->identifier()) {
return new EntitySubmitResult(
EntitySubmitResult::DISPOSITION_ERROR,
errorCode: 'sent_collection_not_found',
errorMessage: 'No Sent target collection is configured or could be resolved for this service',
);
}
$patch = null;
if ($message !== null) {
[$nativeMessage, $nativeAttachments] = $this->messagePayload($message);
} else {
$nativeMessage = null;
$nativeAttachments = [];
$patch = $this->normalizeMessageProperties($message)->toJmap();
}
$transportId = $this->mailService->entitySubmitDraft(
$identityId,
(string)$source->entity(),
(string)$source->collection(),
$postSentTarget->collection(),
$nativeMessage,
$nativeAttachments,
);
$transportId = $this->mailService->entitySubmitDraft($identityId, (string)$source->entity(), $patch);
return new EntitySubmitResult(
EntitySubmitResult::DISPOSITION_SENT,
@@ -990,50 +912,16 @@ class Service implements ServiceBaseInterface, ServiceMutableInterface, ServiceC
);
}
/**
* Convert message properties and describe attachment blobs for the remote
* service. Uploading and request batching remain remote-layer concerns.
*
* @return array{0: array, 1: array<string, array{type: string, content: string}>}
*/
private function messagePayload(MessagePropertiesMutableInterface $message): array
private function normalizeMessageProperties(MessagePropertiesMutableInterface $message): MessageProperties
{
if ($message instanceof MessageProperties === false) {
$native = new MessageProperties([]);
$native->jsonDeserialize($message->jsonSerialize());
} else {
$native = $message;
if ($message instanceof MessageProperties) {
return $message;
}
$attachments = $native->getAttachments();
$uploads = [];
$native = new MessageProperties([]);
$native->jsonDeserialize($message->jsonSerialize());
foreach ($attachments as $attachment) {
if ($attachment->getBlobId() !== null) {
continue;
}
$content = $attachment->getContent();
if ($content === null) {
throw new \InvalidArgumentException(sprintf(
'Attachment "%s" has neither content nor a JMAP blob identifier',
$attachment->getName() ?? 'unnamed',
));
}
$creationId = 'attachment_' . count($uploads);
$attachment->setBlobId('#' . $creationId);
$uploads[$creationId] = [
'type' => $attachment->getType() ?? 'application/octet-stream',
'content' => $content,
];
}
if ($attachments !== []) {
$native->setAttachments(...$attachments);
}
return [$native->toJmap(), $uploads];
return $native;
}
private function resolveCollectionByRole(string $role): ?CollectionIdentifier
+53 -206
View File
@@ -11,7 +11,6 @@ namespace KTXM\ProviderJmapc\Service\Remote;
use Exception;
use JmapClient\Client;
use JmapClient\Requests\Blob\BlobSet;
use JmapClient\Requests\Mail\MailboxGet;
use JmapClient\Requests\Mail\MailboxParameters as MailboxParametersRequest;
use JmapClient\Requests\Mail\MailboxQuery;
@@ -728,8 +727,7 @@ class RemoteMailService {
*
* @since Release 1.0.0
*/
public function entityCreate(string $location, array $so, array $attachments = []): ?array {
$blobRequest = $this->prepareAttachmentRequest($so, $attachments);
public function entityCreate(string $location, array $so): ?array {
// convert entity
$to = new MailParametersRequest();
$to->parametersRaw($so);
@@ -739,11 +737,9 @@ class RemoteMailService {
$r0 = new MailSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$r0->create($id, $to);
// transceive
$requests = $blobRequest !== null ? [$blobRequest, $r0] : [$r0];
$bundle = $this->dataStore->perform($requests);
$this->assertAttachmentUploads($bundle, $blobRequest, $attachments, $so);
$bundle = $this->dataStore->perform([$r0]);
// extract response
$response = $bundle->response($blobRequest !== null ? 1 : 0);
$response = $bundle->response(0);
// check for command error
if ($response instanceof ResponseException) {
if ($response->type() === 'unknownMethod') {
@@ -773,64 +769,27 @@ class RemoteMailService {
*
* @since Release 1.0.0
*/
public function entityReplace(array $so, array $attachments = []): ?array {
// JMAP Email content is immutable after creation. Replacing a draft must
// therefore create a new Email and remove the superseded Email together.
$id = (string)($so['id'] ?? '');
unset($so['id']);
if ($id === '') {
throw new Exception('Draft identifier is required for replacement', 1);
public function entityModify(array $so): ?array {
// extract entity id
$id = $so['id'];
// convert entity
$to = new MailParametersRequest();
$to->parametersRaw($so);
// construct request
$r0 = new MailSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$r0->update($id, $to);
// transceive
$bundle = $this->dataStore->perform([$r0]);
// extract response
$response = $bundle->response(0);
// determine if command succeeded
if (array_key_exists($id, $response->updated())) {
// update entity
$ro = $response->updated()[$id];
$so = array_merge($so, $ro);
return $so;
}
$location = null;
foreach (($so['mailboxIds'] ?? []) as $mailboxId => $included) {
if ($included === true) {
$location = (string)$mailboxId;
break;
}
}
if ($location === null || $location === '') {
throw new Exception('Draft mailbox is required for replacement', 1);
}
$blobRequest = $this->prepareAttachmentRequest($so, $attachments);
$replacement = new MailParametersRequest();
$replacement->parametersRaw($so);
$replacement->in($location);
$creationId = uniqid();
// Email/set supports create and destroy in one method call. When attachment
// content is present, Blob/upload is included in the same HTTP request.
$request = new MailSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$request->create($creationId, $replacement);
$request->delete($id);
$requests = $blobRequest !== null ? [$blobRequest, $request] : [$request];
$bundle = $this->dataStore->perform($requests);
$this->assertAttachmentUploads($bundle, $blobRequest, $attachments, $so);
$response = $bundle->response($blobRequest !== null ? 1 : 0);
if ($response instanceof ResponseException) {
if ($response->type() === 'unknownMethod') {
throw new JmapUnknownMethod($response->description(), 1);
}
throw new Exception($response->type() . ': ' . $response->description(), 1);
}
$created = $response->createSuccess($creationId);
if ($created === null) {
$failure = $response->createFailure($creationId);
$type = $failure['type'] ?? 'unknownError';
$description = $failure['description'] ?? 'JMAP draft replacement failed.';
throw new Exception("$type: $description", 1);
}
if ($response->deleteSuccess($id) === null) {
$failure = $response->deleteFailure($id);
$type = $failure['type'] ?? 'unknownError';
$description = $failure['description'] ?? 'The superseded JMAP draft could not be deleted.';
throw new Exception("$type: $description", 1);
}
return array_merge($so, $created);
return null;
}
public function entityPatch(MailParametersRequest $properties, string ...$identifiers): ?array {
@@ -953,49 +912,24 @@ class RemoteMailService {
*
* @since Release 2.0.0
*/
public function entitySubmitFresh(string $identityId, array $data, string $preSendTarget, string $postSentTarget, array $attachments = []): string {
$blobRequest = $this->prepareAttachmentRequest($data, $attachments);
public function entitySubmitFresh(string $identityId, array $message, string $preSendTarget, string $postSentTarget): string {
$message = new MailParametersRequest();
$message->parametersRaw($data);
$mail = new MailParametersRequest();
$mail->parametersRaw($message);
$messageId = 'm_' . uniqid();
$submissionId = 's_' . uniqid();
$messageCreateId = 'm_' . uniqid();
$submissionCreateId = 's_' . uniqid();
$r0 = new MailSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$m0 = $r0->create($messageId, $message);
$m0->in($preSendTarget);
$m0->draft(true);
$m0->seen(true);
$createdMessage = $r0->create($messageCreateId, $mail);
$createdMessage->in($preSendTarget);
$r1 = new MailSubmissionSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$r1->completionUpdate('#' . $messageId, [
'mailboxIds/' . $postSentTarget => true,
'mailboxIds/' . $preSendTarget => null,
'keywords/$draft' => null,
]);
$s0 = $r1->create($submissionId);
$s0->identity($identityId);
$s0->message('#' . $messageId);
$submission = $r1->create($submissionCreateId);
$submission->identity($identityId);
$submission->message('#' . $messageCreateId);
$requests = $blobRequest !== null ? [$blobRequest, $r0, $r1] : [$r0, $r1];
$bundle = $this->dataStore->perform($requests);
$this->assertAttachmentUploads($bundle, $blobRequest, $attachments, $data);
$responseOffset = $blobRequest !== null ? 1 : 0;
$messageResponse = $bundle->response($responseOffset);
if ($messageResponse instanceof ResponseException) {
throw new Exception($messageResponse->type() . ': ' . $messageResponse->description(), 1);
}
if (method_exists($messageResponse, 'createFailure')) {
$failure = $messageResponse->createFailure($messageId);
if (is_array($failure)) {
$type = $failure['type'] ?? 'unknownError';
$description = $failure['description'] ?? 'Email creation failed';
throw new Exception($type . ': ' . $description, 1);
}
}
$response = $bundle->response($responseOffset + 1);
$bundle = $this->dataStore->perform([$r0, $r1]);
$response = $bundle->response(1);
if ($response instanceof ResponseException) {
if ($response->type() === 'unknownMethod') {
throw new JmapUnknownMethod($response->description(), 1);
@@ -1003,49 +937,37 @@ class RemoteMailService {
throw new Exception($response->type() . ': ' . $response->description(), 1);
}
return $this->extractSubmissionIdentifier($response, $submissionId);
return $this->extractSubmissionIdentifier($response, $submissionCreateId);
}
/**
* Submit an existing draft message. On success, the draft Email is moved
* from the drafts mailbox to the sent mailbox and its \Draft keyword is
* cleared in the same request, so the submitted draft becomes the sent
* copy rather than lingering as an unsent draft.
* Submit an existing draft message.
*
* @since Release 2.0.0
*/
public function entitySubmitDraft(string $identityId, string $draftId, string $preSendTarget, string $postSentTarget, ?array $patch = null, array $attachments = []): string {
public function entitySubmitDraft(string $identityId, string $draftId, ?array $patch = null): string {
if ($draftId === '') {
throw new Exception('Draft identifier is required for draft submission', 1);
}
$blobRequest = $patch !== null ? $this->prepareAttachmentRequest($patch, $attachments) : null;
$requests = $blobRequest !== null ? [$blobRequest] : [];
$requests = [];
if ($patch !== null && $patch !== []) {
$m0 = new MailParametersRequest();
$m0->parametersRaw($patch);
$draftMutation = new MailParametersRequest();
$draftMutation->parametersRaw($patch);
$r0 = new MailSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$r0->update($draftId, $m0);
$r0->update($draftId, $draftMutation);
$requests[] = $r0;
}
$submissionId = 's_' . uniqid();
$submissionCreateId = 's_' . uniqid();
$r1 = new MailSubmissionSet($this->dataAccount, null, $this->resourceNamespace, $this->resourceEntityLabel);
$r1->completionUpdate($draftId, [
'mailboxIds/' . $postSentTarget => true,
'mailboxIds/' . $preSendTarget => null,
'keywords/$draft' => null,
]);
$s0 = $r1->create($submissionId);
$s0->identity($identityId);
$s0->message($draftId);
$submission = $r1->create($submissionCreateId);
$submission->identity($identityId);
$submission->message($draftId);
$requests[] = $r1;
$bundle = $this->dataStore->perform($requests);
if ($patch !== null) {
$this->assertAttachmentUploads($bundle, $blobRequest, $attachments, $patch);
}
$responseIndex = count($requests) - 1;
$response = $bundle->response($responseIndex);
if ($response instanceof ResponseException) {
@@ -1055,94 +977,19 @@ class RemoteMailService {
throw new Exception($response->type() . ': ' . $response->description(), 1);
}
return $this->extractSubmissionIdentifier($response, $submissionId);
return $this->extractSubmissionIdentifier($response, $submissionCreateId);
}
/**
* Upload attachment content and return its JMAP blob identifier.
*/
public function blobDeposit(string $type, string $data): string {
$response = json_decode($this->dataStore->upload($this->dataAccount, $type, $data), true);
if (!is_array($response) || !isset($response['blobId']) || !is_string($response['blobId']) || $response['blobId'] === '') {
throw new Exception('JMAP attachment upload did not return a blob identifier', 1);
}
private function collectionByRole(string $role): ?string {
$filter = $this->collectionListFilter();
$filter->condition('role', $role);
return $response['blobId'];
}
/**
* Build one Blob/upload method call for all new attachment content. Servers
* without the Blob capability fall back to the standard upload endpoint.
*
* @param array<string, array{type: string, content: string}> $attachments
*/
private function prepareAttachmentRequest(array &$data, array $attachments): ?BlobSet {
if ($attachments === []) {
$collections = $this->collectionList(null, $filter, null);
if ($collections === []) {
return null;
}
if (!$this->dataStore->sessionCapable('blob')) {
foreach ($attachments as $creationId => $attachment) {
$blobId = $this->blobDeposit($attachment['type'], $attachment['content']);
$this->replaceBlobReference($data, '#' . $creationId, $blobId);
}
return null;
}
$request = new BlobSet($this->dataAccount);
foreach ($attachments as $creationId => $attachment) {
$request->create($creationId)
->type($attachment['type'])
->dataEncoded(base64_encode($attachment['content']));
}
return $request;
}
/**
* Validate a batched Blob/upload response and replace creation references
* in the returned local representation with actual server blob IDs.
*
* @param array<string, array{type: string, content: string}> $attachments
*/
private function assertAttachmentUploads(object $bundle, ?BlobSet $request, array $attachments, array &$data): void {
if ($request === null) {
return;
}
$response = $bundle->response(0);
if ($response instanceof ResponseException) {
throw new Exception('Attachment upload failed: ' . $response->type() . ': ' . $response->description(), 1);
}
foreach (array_keys($attachments) as $creationId) {
$failure = $response->createFailure($creationId);
if ($failure !== null) {
$type = $failure['type'] ?? 'unknownError';
$description = $failure['description'] ?? 'Attachment upload failed.';
throw new Exception("$type: $description", 1);
}
$success = $response->createSuccess($creationId);
$blobId = is_array($success) ? ($success['id'] ?? null) : null;
if (!is_string($blobId) || $blobId === '') {
throw new Exception('Attachment upload did not return a blob identifier', 1);
}
$this->replaceBlobReference($data, '#' . $creationId, $blobId);
}
}
private function replaceBlobReference(array &$data, string $reference, string $blobId): void {
foreach ($data as &$value) {
if (is_array($value)) {
$this->replaceBlobReference($value, $reference, $blobId);
continue;
}
if ($value === $reference) {
$value = $blobId;
}
}
unset($value);
return (string)array_key_first($collections);
}
private function extractSubmissionIdentifier(object $response, string $createId): string {
+2 -6
View File
@@ -73,13 +73,9 @@ class RemoteService {
}
// debugging
if ($service->getDebug()) {
$logDirectory = dirname(__DIR__, 5) . '/var/logs/provider_jmap';
if (!is_dir($logDirectory) && !mkdir($logDirectory, 0775, true) && !is_dir($logDirectory)) {
throw new \RuntimeException(sprintf('Unable to create JMAP log directory: %s', $logDirectory));
}
$logFile = $logDirectory . '/' . $service->identifier() . '.json';
$logDir = dirname(__DIR__, 5) . '/var/log/jmap/' . $service->identifier() . '.json';
$client->configureTransportLogState(true);
$client->configureTransportLogLocation($logFile);
$client->configureTransportLogLocation($logDir);
}
// return
return $client;
-11
View File
@@ -176,15 +176,4 @@ class ServiceStore
return $result->getDeletedCount() > 0;
}
/**
* Delete every service owned by a user.
*/
public function deleteByUser(string $tenantId, string $userId): void
{
$this->dataStore->selectCollection(self::COLLECTION_NAME)->deleteMany([
'tid' => $tenantId,
'uid' => $userId,
]);
}
}
+2 -2
View File
@@ -274,7 +274,7 @@ async function initiateOAuth() {
variant="outlined"
prepend-inner-icon="mdi-account"
class="mb-4"
autocomplete="off"
autocomplete="username"
autocorrect="off"
autocapitalize="none"
:rules="[rules.required]"
@@ -289,7 +289,7 @@ async function initiateOAuth() {
variant="outlined"
prepend-inner-icon="mdi-lock"
class="mb-4"
autocomplete="new-password"
autocomplete="current-password"
:rules="[rules.required]"
/>
</template>
+65 -15
View File
@@ -25,7 +25,7 @@ const settingGroups = [
title: 'Addresses',
value: 'addresses' as const,
icon: 'mdi-at',
description: 'View the primary mailbox identity and sender aliases synced from the JMAP server.'
description: 'Configure the primary mailbox identity and any sender aliases exposed by this service.'
},
{
title: 'Messages',
@@ -71,7 +71,7 @@ watch(
)
watch(
[deleteMode, deleteDestination],
[deleteMode, deleteDestination, primaryAddress, secondaryAddresses],
() => {
const nextService = props.service ?? new ServiceObject()
const nextAuxiliary = {
@@ -83,9 +83,13 @@ watch(
}
if (sameAuxiliary(nextService.auxiliary ?? {}, nextAuxiliary)) {
return
if (sameAddresses(nextService)) {
return
}
}
nextService.primaryAddress = primaryAddress.value.empty ? null : primaryAddress.value
nextService.secondaryAddresses = dedupeAddresses(secondaryAddresses.value)
nextService.auxiliary = nextAuxiliary
emit('update:service', nextService)
},
@@ -107,10 +111,44 @@ function normalizeDeleteDestination(value: string): string {
return trimmedValue.length > 0 ? trimmedValue : 'Trash'
}
function dedupeAddresses(entries: ServiceAddressObject[]): ServiceAddressObject[] {
const populated = entries.filter(entry => !entry.empty)
return populated.filter((entry, index) =>
populated.findIndex(candidate => candidate.matches(entry.address)) === index)
}
function addSecondaryAddress() {
secondaryAddresses.value.push(new ServiceAddressObject())
}
function removeSecondaryAddress(index: number) {
secondaryAddresses.value.splice(index, 1)
}
function validAddress(value: string): boolean | string {
const trimmedValue = value.trim()
return trimmedValue.length === 0 || /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(trimmedValue) || 'Invalid email address'
}
function sameAuxiliary(current: Record<string, any>, next: Record<string, any>): boolean {
return (current.deleteMode === 'hard' ? 'hard' : 'soft') === next.deleteMode
&& (current.deleteDestination ?? undefined) === (next.deleteDestination ?? undefined)
}
function sameAddresses(service: ServiceObject): boolean {
const nextPrimary = primaryAddress.value.empty ? null : primaryAddress.value
const nextSecondary = dedupeAddresses(secondaryAddresses.value)
return sameAddress(service.primaryAddress, nextPrimary)
&& service.secondaryAddresses.length === nextSecondary.length
&& service.secondaryAddresses.every((entry, index) => sameAddress(entry, nextSecondary[index]))
}
function sameAddress(current: ServiceAddressObject | null, next: ServiceAddressObject | null): boolean {
if (current === null || next === null) {
return current === next
}
return current.equals(next)
}
</script>
<template>
@@ -138,57 +176,69 @@ function sameAuxiliary(current: Record<string, any>, next: Record<string, any>):
<div class="jmap-settings-card">
<h3 class="text-h6 mb-2">Addresses</h3>
<p class="text-body-2 text-medium-emphasis mb-6">
The primary mailbox identity and sender aliases are managed by the JMAP server and synced automatically.
Configure the primary mailbox identity and any additional sender aliases exposed by this service.
</p>
<div class="text-subtitle-2 mb-2">Primary Address</div>
<div class="d-flex ga-2 mb-6">
<v-text-field
:model-value="primaryAddress.label"
v-model="primaryAddress.label"
label="Display Name"
variant="outlined"
density="compact"
hide-details="auto"
readonly
/>
<v-text-field
:model-value="primaryAddress.address"
v-model="primaryAddress.address"
label="Email Address"
variant="outlined"
density="compact"
prepend-inner-icon="mdi-email-outline"
:rules="[validAddress]"
hide-details="auto"
readonly
/>
</div>
<div class="text-subtitle-2 mb-2">Secondary Addresses</div>
<p v-if="secondaryAddresses.length === 0" class="text-body-2 text-medium-emphasis">
No aliases reported by the server.
</p>
<div
v-for="(entry, index) in secondaryAddresses"
:key="index"
class="d-flex ga-2 mb-2"
>
<v-text-field
:model-value="entry.label"
v-model="entry.label"
label="Display Name"
variant="outlined"
density="compact"
hide-details="auto"
readonly
/>
<v-text-field
:model-value="entry.address"
v-model="entry.address"
label="Email Address"
variant="outlined"
density="compact"
prepend-inner-icon="mdi-email-multiple-outline"
:rules="[validAddress]"
hide-details="auto"
readonly
/>
<v-btn
icon
size="small"
variant="text"
@click="removeSecondaryAddress(index)"
>
<v-icon>mdi-delete-outline</v-icon>
<v-tooltip activator="parent" location="bottom">Remove Alias</v-tooltip>
</v-btn>
</div>
<v-btn
variant="tonal"
prepend-icon="mdi-plus"
@click="addSecondaryAddress"
>
Add Alias
</v-btn>
</div>
</v-window-item>