forked from plesk/pm-api-stubs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathWebmail.php
41 lines (36 loc) · 1.41 KB
/
Webmail.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?php
// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
namespace Plesk\SDK;
final class Webmail
{
/**
* @param string $name Webmail name that will be used as an identifier of this webmail. Must be unique within the extension.
* @param string $displayName Name that will be displayed in Plesk UI.
*/
public function __construct(string $name, string $displayName) { }
/**
* Mustache template that will generate the login link to the webmail in Plesk UI.
*
* For example: {{ protocol }}://webmail.{{ domainName }}/index.php?login={{ fullMailName }}
* Available context:
* * domainName: string, domain name of the selected domain
* * mailName: string, local part of the email
* * fullMailName: string, full email address, urlencoded (e.g. user%40example.com)
* * protocol: string, either "http", or "https"
*
* @param string $loginLinkTemplate
* @return $this
*
* @since 18.0.47
*/
public function setLoginLinkTemplate(string $loginLinkTemplate): self { }
/**
* A callback function that decides whether webmail should be visible for a domain or not.
*
* @param callable $callback Callback that takes \pm_Domain as an argument and returns a boolean value.
* @return $this
*
* @since 18.0.47
*/
public function setIsVisibleForDomainCallback(callable $callback): self { }
}