Пользовательские дополнения

На главную


mailBox.RequestMail( mailId )

Запрашивает у сервера информацию о письме с заданным id. Удачное получение запрошенной информации отмечается событием EVENT_MAILBOX_CHANGED. Статус исполнения запроса (удачно или причина ошибки) приходит в событии EVENT_MAILBOX_SERVER_OPERATION_RESULT. Пришедшую с сервера информацию можно получить посредством mailBox.GetMail( mailId ). После прихода сообщения EVENT_MAILBOX_CHANGED_ON_SERVER информация, полученная по этому запросу, будет очищена и пока запрос не будет выполнен заново mailBox.GetMail( mailId ) будет возвращать nil.

Предназначается для обновления (после прихода сообщения EVENT_MAILBOX_SERVER_OPERATION_RESULT) информации о письме, первоначально полученной запросом mailBox.RequestMails( startIndex, count ) и функцией mailBox.GetMails().

Запрос не может быть послан (будет проигнорирован) до окончания предыдущего запроса (появления ответа от сервера или истечения таймаута, около 1 минуты), но может быть послан независимо от запроса mailBox.RequestMails( startIndex, count ). Можно ли в данный момент посылать запрос - см. mailBox.IsReady().

-- библиотека:
mailBox

-- объявление:
function RequestMail( mailId )

-- параметры:
mailId: ObjectId - идентификатор письма

-- возвращаемые значения:
нет

-- пример:
mailBox.RequestMail( mailId )

См. также

Связанные страницы: "CategoryLuaApi" "CategoryMailBox"

CategoryMailBox
EnumCreateMailResult
EnumMailServiceReply
EventMailBoxActivated
EventMailBoxChanged
EventMailBoxChangedOnServer
EventMailBoxClosed
EventMailboxNewMailArrived
EventMailboxNewUnreadMessage
EventMailBoxServerOperationResult
EventMailCreateResult
EventMailDeleteResult
EventMailExtractItemsResult
EventMailExtractMoneyResult
EventMailReturnResult
EventMailsChanged
FunctionMailBoxClose
FunctionMailBoxDeleteMail
FunctionMailBoxExtractMailItems
FunctionMailBoxExtractMailMoney
FunctionMailBoxFirstPage
FunctionMailBoxGetInfo
FunctionMailBoxGetLimits
FunctionMailBoxGetMail
FunctionMailBoxGetMails
FunctionMailBoxIsActive
FunctionMailBoxIsInteracting
FunctionMailBoxIsReady
FunctionMailBoxNextPage
FunctionMailBoxOpen
FunctionMailBoxPrevPage
FunctionMailBoxReadMail
FunctionMailBoxRequestMail
FunctionMailBoxRequestMailGroupOperation
FunctionMailBoxRequestMailIds
FunctionMailBoxRequestMailInfo
FunctionMailBoxRequestMails
FunctionMailBoxReturnMailToSender
VoteId


CategoryLuaApi CategoryFunction CategoryMailBox

На главную