IManager
in
Mail Provider Manager Interface
This interface is a base requirement of methods and functionality used to construct a mail provider manager object
Tags
Table of Contents
Methods
- count() : int
- retrieve a count of how many mail providers are registered
- findProviderById() : IProvider|null
- retrieve a provider with a specific id
- findServiceByAddress() : IService|null
- retrieve a service for a specific mail address returns first service with specific primary address
- findServiceById() : IService|null
- retrieve a service with a specific id
- has() : bool
- determine if any mail providers are registered
- providers() : array<string, IProvider>
- retrieve all registered mail providers
- services() : array<string, array<string, IService>>
- retrieve all services for all registered mail providers
- types() : array<string, string>
- retrieve which mail providers are registered
Methods
count()
retrieve a count of how many mail providers are registered
public
count() : int
Tags
Return values
intfindProviderById()
retrieve a provider with a specific id
public
findProviderById(string $providerId) : IProvider|null
Parameters
- $providerId : string
-
provider id
Tags
Return values
IProvider|nullfindServiceByAddress()
retrieve a service for a specific mail address returns first service with specific primary address
public
findServiceByAddress(string $userId, string $address[, string $providerId = null ]) : IService|null
Parameters
- $userId : string
-
user id
- $address : string
-
mail address (e.g. test@example.com)
- $providerId : string = null
-
provider id
Tags
Return values
IService|null —returns service object or null if none found
findServiceById()
retrieve a service with a specific id
public
findServiceById(string $userId, string $serviceId[, string $providerId = null ]) : IService|null
Parameters
- $userId : string
-
user id
- $serviceId : string
-
service id
- $providerId : string = null
-
provider id
Tags
Return values
IService|null —returns service object or null if none found
has()
determine if any mail providers are registered
public
has() : bool
Tags
Return values
boolproviders()
retrieve all registered mail providers
public
providers() : array<string, IProvider>
Tags
Return values
array<string, IProvider> —collection of provider id and object ['jmap' => IProviderObject]
services()
retrieve all services for all registered mail providers
public
services(string $userId) : array<string, array<string, IService>>
Parameters
- $userId : string
-
user id
Tags
Return values
array<string, array<string, IService>> —collection of provider id, service id and object ['jmap' => ['Service1' => IServiceObject]]
types()
retrieve which mail providers are registered
public
types() : array<string, string>
Tags
Return values
array<string, string> —collection of provider id and label ['jmap' => 'JMap Connector']