javax.mail
Интерфейс UIDFolder


public interface UIDFolder

UIDFolder интерфейс реализуется Папками, которые могут поддерживать "разъединенный" режим работы, обеспечивая уникальные идентификаторы для сообщений в папке. Этот интерфейс основан на модели IMAP для того, чтобы поддерживать разъединенную работу.

Уникальный идентификатор (UID) является положительным длинным значением, присвоенным каждому сообщению в определенной папке. Уникальные идентификаторы присваиваются строго возрастающим способом в почтовом ящике. Таким образом, поскольку каждое сообщение добавляется к почтовому ящику, это присваивается более высокий UID чем сообщение (я), которые были добавлены ранее. Уникальные идентификаторы сохраняются через сеансы. Это разрешает клиенту ресинхронизировать его состояние от предыдущего сеанса с сервером.

Связанный с каждым почтовым ящиком значение законности уникального идентификатора. Если уникальные идентификаторы от более раннего сеанса не в состоянии сохраниться к этому сеансу, значение законности уникального идентификатора должно быть больше чем то, используемое в более раннем сеансе.

Обратитесь к RFC 2060 http://www.ietf.org/rfc/rfc2060.txt для получения дополнительной информации.

Автор:
Джон Мани

Вложенная Сводка Класса
static class UIDFolder. FetchProfileItem
          Элемент профиля выборки для того, чтобы выбрать UID.
 
Полевая Сводка
static long LASTUID
          Это - специальное значение, которое может использоваться в качестве end параметр в getMessagesByUID(start, end), обозначить UID последнего сообщения в папке.
 
Сводка метода
 Сообщение getMessageByUID(long uid)
          Получите сообщение, соответствующее данному UID.
 Сообщение[] getMessagesByUID(long[] uids)
          Определите сообщения данным массивом UID.
 Сообщение[] getMessagesByUID(long start, long end)
          Определите сообщения данным диапазоном.
 long getUID(Message message)
          Получите UID для указанного сообщения.
 long getUIDValidity()
          Возвращает значение UIDValidity, связанное с этой папкой.
 

Полевая Деталь

LASTUID

static final long LASTUID
Это - специальное значение, которое может использоваться в качестве end параметр в getMessagesByUID(start, end), обозначить UID последнего сообщения в папке.

См. Также:
getMessagesByUID(long, long), Постоянные Значения полей
Деталь метода

getUIDValidity

long getUIDValidity()
                    throws MessagingException
Возвращает значение UIDValidity, связанное с этой папкой.

Клиенты обычно сравнивают это значение со значением UIDValidity, сохраненным от предыдущего сеанса, чтобы обеспечить, чтобы любые кэшируемые UID не были устарелыми.

Возвраты:
UIDValidity
Броски:
MessagingException

getMessageByUID

Message getMessageByUID(long uid)
                        throws MessagingException
Получите сообщение, соответствующее данному UID. Если никакое такое сообщение не существует, null возвращается.

Параметры:
uid - UID для требуемого сообщения
Возвраты:
объект сообщения. null возвращается, если никакое сообщение, соответствующее этому UID, не получается.
Броски:
MessagingException

getMessagesByUID

Message[] getMessagesByUID(long start,
                           long end)
                           throws MessagingException
Определите сообщения данным диапазоном. Специальное значение LASTUID может использоваться для end параметр, чтобы указать на UID последнего сообщения в папке.

Отметьте это end не должно быть больше чем start; порядок диапазона не имеет значения. Отметьте также, что, если папка не пуста, использование LASTUID гарантирует, что по крайней мере одно сообщение будет возвращено - последнее сообщение в папке.

Параметры:
start - запустите UID
end - UID конца
Возвраты:
массив объектов сообщения
Броски:
MessagingException
См. Также:
LASTUID

getMessagesByUID

Message[] getMessagesByUID(long[] uids)
                           throws MessagingException
Определите сообщения данным массивом UID. Если какой-либо UID недопустим, null возвращается для той записи.

Отметьте, что возвращенный массив будет иметь тот же самый размер как указанный массив UID, и null записи могут присутствовать в массиве, чтобы указать на недопустимые UID.

Параметры:
uids - массив UID
Возвраты:
массив объектов сообщения
Броски:
MessagingException

getUID

long getUID(Message message)
            throws MessagingException
Получите UID для указанного сообщения. Отметьте, что сообщение должно принадлежать этой папке. Иначе java.util. NoSuchElementException бросается.

Параметры:
message - Сообщение от этой папки
Возвраты:
UID для этого сообщения
Броски:
java.util.NoSuchElementException - если данное сообщение не находится в этой Папке.
MessagingException


Представьте ошибку или функцию

Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается срокам действия лицензии.

Сгенерированный на 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter