Overview
  • Namespace
  • Class

Namespaces

  • Omines
    • DirectAdmin
      • Context
      • Objects
        • Database
        • Domains
        • Email
        • Users
      • Utility

Classes

  • Forwarder
  • Mailbox
  • MailObject

Class Forwarder

Encapsulates an email forwarder.

Omines\DirectAdmin\Objects\BaseObject
Extended by Omines\DirectAdmin\Objects\DomainObject
Extended by Omines\DirectAdmin\Objects\Email\MailObject
Extended by Omines\DirectAdmin\Objects\Email\Forwarder
Namespace: Omines\DirectAdmin\Objects\Email
Author: Niels Keurentjes niels.keurentjes@omines.com
Located at DirectAdmin/Objects/Email/Forwarder.php

Methods summary

public
# __construct( string $prefix, Omines\DirectAdmin\Objects\Domain $domain, array|string $recipients )

Construct the object.

Construct the object.

Parameters

$prefix
The part before the @ in the address
$domain
The containing domain
$recipients
Array or string containing the recipients

Overrides

Omines\DirectAdmin\Objects\DomainObject::__construct
public static Omines\DirectAdmin\Objects\Email\Forwarder
# create( Omines\DirectAdmin\Objects\Domain $domain, string $prefix, string|string[] $recipients )

Creates a new forwarder.

Creates a new forwarder.

Parameters

$domain
$prefix
$recipients

Returns

Omines\DirectAdmin\Objects\Email\Forwarder
public
# delete( )

Deletes the forwarder.

Deletes the forwarder.

public string[]
# getRecipients( )

Returns a list of the recipients of this forwarder.

Returns a list of the recipients of this forwarder.

Returns

string[]
public string[]
# getAliases( )

Returns the list of valid aliases for this account.

Returns the list of valid aliases for this account.

Returns

string[]

Methods inherited from Omines\DirectAdmin\Objects\Email\MailObject

getEmailAddress(), getPrefix(), invokeDelete()

Methods inherited from Omines\DirectAdmin\Objects\DomainObject

getDomain(), getDomainName(), invokePost(), toDomainObjectArray()

Methods inherited from Omines\DirectAdmin\Objects\BaseObject

clearCache(), getCache(), getCacheItem(), getContext(), getName(), setCache(), toObjectArray(), toRichObjectArray()

API documentation generated by ApiGen