IService
in
Mail Service Interface
This interface is a base requirement of methods and functionality used to construct a mail service object
Tags
Table of Contents
Methods
- capabilities() : array<string|int, mixed>
- retrieves a collection of what actions a service can perfrom
- capable() : bool
- checks if a service is able of performing an specific action
- getLabel() : string
- gets the localized human frendly name of this service
- getPrimaryAddress() : IAddress
- gets the primary mailing address for this service
- getSecondaryAddresses() : array<int, IAddress>
- gets the secondary mailing addresses (aliases) collection for this service
- id() : string
- arbitrary unique text string identifying this service
- initiateMessage() : IMessage
- construct a new empty message object
- setLabel() : self
- sets the localized human frendly name of this service
- setPrimaryAddress() : self
- sets the primary mailing address for this service
- setSecondaryAddresses() : self
- sets the secondary mailing addresses (aliases) for this service
Methods
capabilities()
retrieves a collection of what actions a service can perfrom
public
capabilities() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —collection of abilities otherwise empty collection
capable()
checks if a service is able of performing an specific action
public
capable(string $value) : bool
Parameters
- $value : string
-
required ability e.g. 'MessageSend'
Tags
Return values
bool —true/false if ability is supplied and found in collection
getLabel()
gets the localized human frendly name of this service
public
getLabel() : string
Tags
Return values
string —label/name of service (e.g. ACME Company Mail Service)
getPrimaryAddress()
gets the primary mailing address for this service
public
getPrimaryAddress() : IAddress
Tags
Return values
IAddress —mail address object
getSecondaryAddresses()
gets the secondary mailing addresses (aliases) collection for this service
public
getSecondaryAddresses() : array<int, IAddress>
Tags
Return values
array<int, IAddress> —collection of mail address objects
id()
arbitrary unique text string identifying this service
public
id() : string
Tags
Return values
string —id of this service (e.g. 1 or service1 or anything else)
initiateMessage()
construct a new empty message object
public
initiateMessage() : IMessage
Tags
Return values
IMessage —blank message object
setLabel()
sets the localized human frendly name of this service
public
setLabel(string $value) : self
Parameters
- $value : string
-
label/name of service (e.g. ACME Company Mail Service)
Tags
Return values
self —return this object for command chaining
setPrimaryAddress()
sets the primary mailing address for this service
public
setPrimaryAddress(IAddress $value) : self
Parameters
- $value : IAddress
-
mail address object
Tags
Return values
self —return this object for command chaining
setSecondaryAddresses()
sets the secondary mailing addresses (aliases) for this service
public
setSecondaryAddresses(IAddress ...$value) : self
Parameters
- $value : IAddress
-
collection of one or more mail address objects
Tags
Return values
self —return this object for command chaining