Класс User

Открытые статические члены
static	create ($fields)
static	login ()
static	onLoginExternal (&$params)
static	getReplyTo ($siteId, $userId, $entityType, $entityId, $entityLink=null, $backurl=null)
static	getForwardTo ($siteId, $userId, $entityType)
static	parseEmailRecipient ($to)
static	getUserRelation ($token)
static	onEmailReceived ($to, $message, $recipient, $userRelation, &$error)
static	sendEventAgent ($messageId=0, $cnt=0)
static	getMailUserGroup ()
static	getDefaultEmailFrom ($serverName=false)
static	getUserData ($userList, $nameTemplate)
static	handleSiteUpdate ($fields)
static	handleServerNameUpdate ()
static	clearTokensCache ()

Подробное описание

См. определение в файле user.php строка 10

Методы

clearTokensCache()

clearTokensCache ( )

static

См. определение в файле user.php строка 550

create()

create ( $fields )

static

Creates mail user

Аргументы

array

$fields

User fields.

Возвращает

int|false

См. определение в файле user.php строка 19

getDefaultEmailFrom()

getDefaultEmailFrom ( $serverName = false )

static

См. определение в файле user.php строка 462

getForwardTo()

getForwardTo ( $siteId, $userId, $entityType )

static

Returns Site-User-Entity unique email

Аргументы

string	$siteId	Site ID.
int	$userId	User ID.
string	$entityType	Entity type ID.

Возвращает

array|false

См. определение в файле user.php строка 190

getMailUserGroup()

getMailUserGroup ( )

static

Returns email users group

Возвращает

array

См. определение в файле user.php строка 451

getReplyTo()

getReplyTo ( $siteId, $userId, $entityType, $entityId, $entityLink = null, $backurl = null )

static

Returns User-Entity unique email and entry point URL

Аргументы

string	$siteId	Site ID.
int	$userId	User ID.
string	$entityType	Entity type ID.
int	$entityId	Entity ID.
string	$entityLink	Entity URL.
string	$backurl	Back URL.

Возвращает

array|false

См. определение в файле user.php строка 122

getUserData()

getUserData ( $userList, $nameTemplate )

static

См. определение в файле user.php строка 489

getUserRelation()

getUserRelation ( $token )

static

См. определение в файле user.php строка 253

handleServerNameUpdate()

handleServerNameUpdate ( )

static

См. определение в файле user.php строка 545

handleSiteUpdate()

handleSiteUpdate ( $fields )

static

См. определение в файле user.php строка 537

login()

login ( )

static

Runs user login

Возвращает

void

См. определение в файле user.php строка 67

onEmailReceived()

onEmailReceived ( $to, $message, $recipient, $userRelation, & $error )

static

Sends email related events

Аргументы

string	$to	Recipient email.
array	$message	Message.
string	&$error	Error.

Возвращает

bool

См. определение в файле user.php строка 278

onLoginExternal()

onLoginExternal ( & $params )

static

Returns mail user ID

Аргументы

array

&$params

Auth params.

Возвращает

int|false

См. определение в файле user.php строка 84

parseEmailRecipient()

parseEmailRecipient ( $to )

static

См. определение в файле user.php строка 244

sendEventAgent()

sendEventAgent ( $messageId = 0, $cnt = 0 )

static

Agent method, retrieves stored user message and sends an event

См. определение в файле user.php строка 336

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/mail/lib/user.php