-
Notifications
You must be signed in to change notification settings - Fork 0
Class ZugferdMailConfig
Class representing the config for the Zugferd MailReader
Get the date format to use
public function getDateFormatIdentifier(): string
{
}Returns a value of type string
Set the date format to use
Allowed values: "d-M-Y", "d-M-y", "d M y"
public function setDateFormatIdentifier(string $dateFormatIdentifier): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| dateFormatIdentifier | string | ❌ |
Returns a value of type \ZugferdMailConfig
Get the message key identifier to use
public function getMessageKeyIdentifier(): string
{
}Returns a value of type string
Set the message key identifier to use
Allowed values: "id", "list", "uid"
public function setMessageKeyIdentifier(string $messageKeyIdentifier): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| messageKeyIdentifier | string | ❌ |
Returns a value of type \ZugferdMailConfig
Returns true if the UBL-Syntax support is enabled
public function getUblSupportEnabled(): bool
{
}Returns a value of type bool
Activate or deactivate support for UBL-Syntax
public function setUblSupportEnabled(bool $ublSupportEnabled): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| ublSupportEnabled | bool | ❌ |
Returns a value of type \ZugferdMailConfig
Activate the UBL-Syntax support
public function activateUblSupport(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Deactivate the UBL-Syntax support
public function deactivateUblSupport(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Returns true if the Symfony validation is enabled
public function getSymfonyValidationEnabled(): bool
{
}Returns a value of type bool
Activate or deactivate Symfony validation
public function setSymfonyValidationEnabled(bool $symfonyValidationEnabled): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| symfonyValidationEnabled | bool | ❌ |
Returns a value of type \ZugferdMailConfig
Activate the Symfony validation
public function activateSymfonyValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Deactivate the Symfony validation
public function deactivateSymfonyValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Returns true if the XSD validation is enabled
public function getXsdValidationEnabled(): bool
{
}Returns a value of type bool
Activate or deactivate XSD validation
public function setXsdValidationEnabled(bool $xsdValidationEnabled): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| xsdValidationEnabled | bool | ❌ |
Returns a value of type \ZugferdMailConfig
Activate the XSD validation
public function activateXsdValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Deactivate the XSD validation
public function deactivateXsdValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Returns true if the Kosit validation is enabled
public function getKositValidationEnabled(): bool
{
}Returns a value of type bool
Activate or deactivate Kosit validation
public function setKositValidationEnabled(bool $kositValidationEnabled): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| kositValidationEnabled | bool | ❌ |
Returns a value of type \ZugferdMailConfig
Activate the Kosit validation
public function activateKositValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Deactivate the Kosit validation
public function deactivateKositValidation(): \ZugferdMailConfig
{
}Returns a value of type \ZugferdMailConfig
Add an account definition
public function addAccount(
string $identifier,
string $host,
int $port,
string $protocol,
mixed $encryption,
bool $validateCert,
string $username,
string $password,
?string $authentication = null,
int $timeout = 30,
array $foldersToWatch = [],
array $mimeTypesToWatch = [],
): \ZugferdMailAccount
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| identifier | string | ❌ | |
| host | string | ❌ | |
| port | int | ❌ | |
| protocol | string | ❌ | |
| encryption | mixed | ❌ | |
| validateCert | bool | ❌ | |
| username | string | ❌ | |
| password | string | ❌ | |
| authentication | string | ✔️ | |
| timeout | int | ❌ | |
| foldersToWatch | array | ❌ | |
| mimeTypesToWatch | array | ❌ |
Returns a value of type \ZugferdMailAccount
Add an mail account object
public function addAccountObject(horstoeko\zugferdmail\config\ZugferdMailAccount $account): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| account | horstoeko\zugferdmail\config\ZugferdMailAccount | ❌ |
Returns a value of type \ZugferdMailConfig
Remove an account definition by it's identifier
public function removeAccount(string $identifier): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| identifier | string | ❌ |
Returns a value of type \ZugferdMailConfig
Get the list of defined accounts
public function getAccounts(): array
{
}Returns a value of type \ZugferdMailAccount[]
Build the client manager
public function makeClientManager(): \ClientManager
{
}Returns a value of type \ClientManager
Loads a configuration from a file. The file must exist.
public static function loadFromFile(string $filename): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| filename | string | ❌ |
Returns a value of type \ZugferdMailConfig
Save the configuration to a file
public function saveToFile(string $filename): \ZugferdMailConfig
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| filename | string | ❌ |
Returns a value of type \ZugferdMailConfig
(c) HorstOeko 2024..