Spec-Zone .ru спецификации, руководства, описания, API

javax.mail
Сообщение класса

java.lang.Object
  javax.mail.Message

Все Реализованные Интерфейсы:

Часть

Прямые Известные Подклассы:

MimeMessage

public abstract class Message
расширяет java.lang. Объект
Часть реализаций

Этот class моделирует электронное письмо. Это - абстрактный class. Подклассы обеспечивают фактические реализации.

Сообщение реализует интерфейс Части. Сообщение содержит ряд атрибутов и "контента". У сообщений в пределах папки также есть ряд флагов, которые описывают его состояние в пределах папки.

Сообщение определяет некоторые новые атрибуты в дополнение к определенным в Part интерфейс. Эти атрибуты определяют метаданные для сообщения - то есть, адресуясь и дескриптивной информации о сообщении.

Объекты сообщения получаются или из Папки или создавая новый объект сообщения из соответствующего подкласса. Сообщения, которые были получены, обычно получаются от папки под названием "ЯЩИК ДЛЯ ПРИЕМА СООБЩЕНИЙ".

Объект сообщения, полученный из папки, является только легкой ссылкой на фактическое сообщение. Сообщение 'лениво' заполняется (по требованию), когда каждый элемент требуют от сообщения. Отметьте, что определенные реализации папки могут возвратить объекты сообщения, которые предварительно заполняются определенными определенными пользователем элементами. Чтобы отправить сообщение, соответствующий подкласс сообщения (например, MimeMessage) инстанцируют, атрибуты и контент заполнены в, и сообщение отправляется, используя Transport.send метод.

Автор:

Джон Мани, Билл Шеннон, Макс Спивэк

См. Также:

Part

Вложенная Сводка Класса

static class

Сообщение. RecipientType Этот внутренний class определяет типы получателей, разрешенных сообщением class.

Полевая Сводка

protected boolean	вычеркнутый Истина, если это сообщение было вычеркнуто.
protected Folder	папка Содержание папки, если это сообщение получается из папки
protected int	msgnum Число этого сообщения в пределах его папки, или нуль, если сообщение не было получено от папки.
protected Session	сеанс Объект Сеанса для этого сообщения

Поля, наследованные от интерфейса javax.mail. Часть

ATTACHMENT, INLINE

Сводка конструктора

protected	Message() Версия без аргументов конструктора.
protected	Message(Folder folder, int msgnum) Конструктор, который берет Папку и номер сообщения.
protected	Message(Session session) Конструктор, который берет Сеанс.

Сводка метода

abstract void	addFrom(Address[] addresses) Добавьте эти адреса к существующему "От" атрибута
void	addRecipient(Message.RecipientType type, Address address) Добавьте, что этот получатель адресуется к существующим данного типа.
abstract void	addRecipients(Message.RecipientType type, Address[] addresses) Добавьте эти, получатель адресуется к существующим данного типа.
Адрес[]	getAllRecipients() Получите все адреса получателя для сообщения.
abstract Flags	getFlags() Возвраты a Flags объект, содержащий флаги для этого сообщения.
Папка	getFolder() Получите папку, из которой было получено это сообщение.
abstract Address[]	getFrom() Возвращается "Из" атрибута.
int	getMessageNumber() Получите Номер сообщения для этого сообщения.
abstract java.util.Date	getReceivedDate() Получите дату, это сообщение было получено.
abstract Address[]	getRecipients(Message.RecipientType type) Получите все адреса получателя данного типа.
Адрес[]	getReplyTo() Получите адреса, к которым должны быть направлены ответы.
abstract java.util.Date	getSentDate() Получите дату, которую было отправлено это сообщение.
abstract java.lang.String	getSubject() Получите предмет этого сообщения.
boolean	isExpunged() Проверки, вычеркивается ли это сообщение.
boolean	isSet(Flags.Flag flag) Проверьте ли флаг, определенный в flag параметр устанавливается в этом сообщении.
boolean	match(SearchTerm term) Примените указанный Критерий поиска к этому сообщению.
abstract Message	reply(boolean replyToAll) Получите новое сообщение, подходящее для ответа на это сообщение.
abstract void	saveChanges() Сохраните любые изменения, произведенные в этом сообщении в банк сообщений, когда содержание папки закрывается, если сообщение содержится в папке.
protected void	setExpunged(boolean expunged) Устанавливает вычеркнутый флаг для этого сообщения.
void	setFlag(Flags.Flag flag, boolean set) Установите указанный флаг на этом сообщении к указанному значению.
abstract void	setFlags(Flags flag, boolean set) Установите указанные флаги на этом сообщении к указанному значению.
abstract void	setFrom() Установите "От" атрибута в этом сообщении.
abstract void	setFrom(Address address) Установите "От" атрибута в этом сообщении.
protected void	setMessageNumber(int msgnum) Установите Номер сообщения для этого сообщения.
void	setRecipient(Message.RecipientType type, Address address) Установите адрес получателя.
abstract void	setRecipients(Message.RecipientType type, Address[] addresses) Установите адреса получателя.
void	setReplyTo(Address[] addresses) Установите адреса, к которым должны быть направлены ответы.
abstract void	setSentDate(java.util.Date date) Назначьте отправленную дату этого сообщения.
abstract void	setSubject(java.lang.String subject) Установите предмет этого сообщения.

Методы, наследованные от class java.lang. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Методы, наследованные от интерфейса javax.mail. Часть

addHeader, getAllHeaders, getContent, getContentType, getDataHandler, getDescription, getDisposition, getFileName, getHeader, getInputStream, getLineCount, getMatchingHeaders, getNonMatchingHeaders, getSize, isMimeType, removeHeader, setContent, setContent, setDataHandler, setDescription, setDisposition, setFileName, setHeader, setText, writeTo

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

msgnum

protected int msgnum

Число этого сообщения в пределах его папки, или нуль, если сообщение не было получено от папки.

вычеркнутый

protected boolean expunged

Истина, если это сообщение было вычеркнуто.

папка

protected Folder folder

Содержание папки, если это сообщение получается из папки

сеанс

protected Session session

Объект Сеанса для этого сообщения

Деталь конструктора

Сообщение

protected Message()

Версия без аргументов конструктора.

Сообщение

protected Message(Folder folder,
                  int msgnum)

Конструктор, который берет Папку и номер сообщения. Используемый реализациями Папки.

Параметры:

folder - содержа папку

msgnum - порядковый номер этого сообщения в пределах этой папки

Сообщение

protected Message(Session session)

Конструктор, который берет Сеанс. Используемый для клиента создаваемые объекты сообщения.

Параметры:

session - Объект Сеанса

Деталь метода

getFrom

public abstract Address[] getFrom()
                           throws MessagingException

Возвращается "Из" атрибута. "От" атрибута содержит идентификационные данные человека (людей), который хотел, чтобы это сообщение было отправлено.

В определенных реализациях это может отличаться от объекта, который фактически отправил сообщение.

Этот метод возвраты null если этот атрибут не присутствует в этом сообщении. Возвращает пустой массив, если этот атрибут присутствует, но не содержит адресов.

Возвраты:

массив объектов Адреса

Броски:

MessagingException

setFrom

public abstract void setFrom()
                      throws MessagingException

Установите "От" атрибута в этом сообщении. Значение этого атрибута получается из свойства "mail.user". Если это свойство отсутствует, системное свойство "user.name" используется.

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

setFrom

public abstract void setFrom(Address address)
                      throws MessagingException

Установите "От" атрибута в этом сообщении.

Параметры:

address - отправитель

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

addFrom

public abstract void addFrom(Address[] addresses)
                      throws MessagingException

Добавьте эти адреса к существующему "От" атрибута

Параметры:

addresses - отправители

Броски:

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

MessagingException

getRecipients

public abstract Address[] getRecipients(Message.RecipientType type)
                                 throws MessagingException

Получите все адреса получателя данного типа.

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

Параметры:

type - тип получателя

Возвраты:

массив объектов Адреса

Броски:

MessagingException

См. Также:

Message.RecipientType.TO, Message.RecipientType.CC, Message.RecipientType.BCC

getAllRecipients

public Address[] getAllRecipients()
                           throws MessagingException

Получите все адреса получателя для сообщения. Реализация по умолчанию извлекает TO, CC, и получателей BCC, использующих getRecipients метод.

Этот метод возвраты null если ни один из заголовков получателя не присутствует в этом сообщении. Это может Возвратить пустой массив, если какой-либо заголовок получателя присутствует, но не содержит адресов.

Возвраты:

массив объектов Адреса

Броски:

MessagingException

См. Также:

Message.RecipientType.TO, Message.RecipientType.CC, Message.RecipientType.BCC, getRecipients(javax.mail.Message.RecipientType)

setRecipients

public abstract void setRecipients(Message.RecipientType type,
                                   Address[] addresses)
                            throws MessagingException

Установите адреса получателя. Все адреса указанного типа заменяются параметром адресов.

Параметры:

type - тип получателя

addresses - адреса

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

setRecipient

public void setRecipient(Message.RecipientType type,
                         Address address)
                  throws MessagingException

Установите адрес получателя. Все адреса указанного типа заменяются параметром адреса.

Реализация по умолчанию использует setRecipients метод.

Параметры:

type - тип получателя

address - адрес

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

addRecipients

public abstract void addRecipients(Message.RecipientType type,
                                   Address[] addresses)
                            throws MessagingException

Добавьте эти, получатель адресуется к существующим данного типа.

Параметры:

type - тип получателя

addresses - адреса

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

addRecipient

public void addRecipient(Message.RecipientType type,
                         Address address)
                  throws MessagingException

Добавьте, что этот получатель адресуется к существующим данного типа.

Реализация по умолчанию использует addRecipients метод.

Параметры:

type - тип получателя

address - адрес

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

getReplyTo

public Address[] getReplyTo()
                     throws MessagingException

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

Реализация по умолчанию просто вызывает getFrom метод.

Этот метод возвраты null если соответствующий заголовок не присутствует. Возвращает пустой массив, если заголовок присутствует, но не содержит адресов.

Возвраты:

адреса, к которым должны быть направлены ответы

Броски:

MessagingException

См. Также:

getFrom()

setReplyTo

public void setReplyTo(Address[] addresses)
                throws MessagingException

Установите адреса, к которым должны быть направлены ответы. (Обычно только единственный адрес будет определен.) Не все типы сообщения позволяют этому быть определенным отдельно от отправителя сообщения.

Реализация по умолчанию, обеспеченная здесь только, бросает MethodNotSupportedException.

Параметры:

addresses - адреса, к которым должны быть направлены ответы

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

MethodNotSupportedException - если базовая реализация не поддерживает установку этого атрибута

getSubject

public abstract java.lang.String getSubject()
                                     throws MessagingException

Получите предмет этого сообщения.

Возвраты:

предмет

Броски:

MessagingException

setSubject

public abstract void setSubject(java.lang.String subject)
                         throws MessagingException

Установите предмет этого сообщения.

Параметры:

subject - предмет

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

getSentDate

public abstract java.util.Date getSentDate()
                                    throws MessagingException

Получите дату, которую было отправлено это сообщение.

Возвраты:

дата это сообщение была отправлена

Броски:

MessagingException

setSentDate

public abstract void setSentDate(java.util.Date date)
                          throws MessagingException

Назначьте отправленную дату этого сообщения.

Параметры:

date - отправленная дата этого сообщения

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений

IllegalStateException - если это сообщение получается из папки READ_ONLY.

getReceivedDate

public abstract java.util.Date getReceivedDate()
                                        throws MessagingException

Получите дату, это сообщение было получено.

Возвраты:

дата это сообщение была получена

Броски:

MessagingException

getFlags

public abstract Flags getFlags()
                        throws MessagingException

Возвраты a Flags объект, содержащий флаги для этого сообщения.

Изменение любого из флагов в этом возвращенном объекте Флагов не будет влиять на флаги этого сообщения. Использовать setFlags() сделать это.

Возвраты:

Объект флагов, содержащий флаги для этого сообщения

Броски:

MessagingException

См. Также:

Flags, setFlags(javax.mail.Flags, boolean)

isSet

public boolean isSet(Flags.Flag flag)
              throws MessagingException

Проверьте ли флаг, определенный в flag параметр устанавливается в этом сообщении.

Использование реализации по умолчанию getFlags.

Параметры:

flag - флаг

Возвраты:

значение указанного флага для этого сообщения

Броски:

MessagingException

См. Также:

Flags.Flag, Flags.Flag.ANSWERED, Flags.Flag.DELETED, Flags.Flag.DRAFT, Flags.Flag.FLAGGED, Flags.Flag.RECENT, Flags.Flag.SEEN

setFlags

public abstract void setFlags(Flags flag,
                              boolean set)
                       throws MessagingException

Установите указанные флаги на этом сообщении к указанному значению. Отметьте, что любые флаги в этом сообщении, которые не определяются в данном Flags объект незатронут.

Это приведет к a MessageChangedEvent быть поставленным любому MessageChangedListener зарегистрировалось на этом сообщении, содержащем папку.

Параметры:

flag - Объект флагов, содержащий флаги, которые будут установлены

set - значение, которое будет установлено

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений.

IllegalStateException - если это сообщение получается из папки READ_ONLY.

См. Также:

MessageChangedEvent

setFlag

public void setFlag(Flags.Flag flag,
                    boolean set)
             throws MessagingException

Установите указанный флаг на этом сообщении к указанному значению. Это приведет к a MessageChangedEvent быть поставленным любому MessageChangedListener зарегистрировалось на этом сообщении, содержащем папку.

Реализация по умолчанию использует setFlags метод.

Параметры:

flag - Флаги. Объект флага, содержащий флаг, который будет установлен

set - значение, которое будет установлено

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений.

IllegalStateException - если это сообщение получается из папки READ_ONLY.

См. Также:

MessageChangedEvent

getMessageNumber

public int getMessageNumber()

Получите Номер сообщения для этого сообщения. Номер сообщения объекта сообщения является относительной позицией этого сообщения в его Папке. Отметьте, что номер сообщения для определенного сообщения может измениться во время сеанса, если другие сообщения в Папке удаляются и вычеркиваются.

Допустимые номера сообщения запускаются в 1. Сообщения, которые не принадлежат никакой папке (как недавно составленные или полученные сообщения) имеют 0 как их номер сообщения.

Возвраты:

номер сообщения

setMessageNumber

protected void setMessageNumber(int msgnum)

Установите Номер сообщения для этого сообщения. Этот метод вызывается только классами реализации.

getFolder

public Folder getFolder()

Получите папку, из которой было получено это сообщение. Если это - новое сообщение или вложенное сообщение, этот нуль возвратов метода.

Возвраты:

содержание папки

isExpunged

public boolean isExpunged()

Проверки, вычеркивается ли это сообщение. Все другие методы кроме getMessageNumber() недопустимы на вычеркнутом объекте сообщения.

Сообщения, которые вычеркиваются из-за explict expunge() запрос на содержании Папки сразу удаляется из Папки. Сообщения, которые внешне вычеркиваются другим источником, отмечаются "вычеркнутые" и возвращают true для isExpunged () метод, но они не удаляются из Папки до явного expunge() делается на Папке.

См. описание expunge() для большего количества деталей о вычеркивают обработку.

См. Также:

Folder#expunge

setExpunged

protected void setExpunged(boolean expunged)

Устанавливает вычеркнутый флаг для этого сообщения. Этот метод должен использоваться только классами реализации.

Параметры:

expunged - вычеркнутый флаг

ответ

public abstract Message reply(boolean replyToAll)
                       throws MessagingException

Получите новое сообщение, подходящее для ответа на это сообщение. У нового сообщения будут свои атрибуты и заголовки установленными соответственно. Отметьте, что этот новый объект сообщения будет пуст, то есть, у него не будет "контента". Они должны будут быть соответственно заполнены в клиентом.

Если replyToAll устанавливается, новое сообщение будет адресоваться всем получателям этого сообщения. Иначе, ответ будет адресоваться только отправителю этого сообщения (использующий значение getReplyTo метод).

Поле "Subject" заполнено в исходным предметом, снабженным префиксом "Ре:" (если это уже не запускается с "Ре:").

Ответное сообщение будет использовать тот же самый сеанс в качестве этого сообщения.

Параметры:

replyToAll - ответ должен быть отправлен всем получателям этого сообщения

Возвраты:

ответное сообщение

Броски:

MessagingException

saveChanges

public abstract void saveChanges()
                          throws MessagingException

Сохраните любые изменения, произведенные в этом сообщении в банк сообщений, когда содержание папки закрывается, если сообщение содержится в папке. (Некоторые реализации могут сразу сохранить изменения.) Обновляют любые поля заголовка, чтобы быть непротиворечивыми с измененным содержанием сообщения. Если какая-либо часть заголовков сообщения или содержания изменяется, saveChanges нужно вызвать, чтобы гарантировать, что те изменения являются постоянными. Если saveChanges не вызывают, любые такие модификации могут или не могут быть сохранены, в зависимости от реализации папки и банка сообщений.

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

Броски:

MessagingException

IllegalStateException - если это сообщение получается из папки READ_ONLY.

IllegalWriteException - если базовая реализация не поддерживает модификацию существующих значений.

соответствие

public boolean match(SearchTerm term)
              throws MessagingException

Примените указанный Критерий поиска к этому сообщению.

Параметры:

term - Критерий поиска

Возвраты:

истина, если сообщение соответствует этот критерий поиска, ложь иначе.

Броски:

MessagingException

См. Также:

SearchTerm