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

javax.mail
Часть интерфейса

Все Известные Подынтерфейсы:

MimePart

Все Известные Классы с реализацией:

BodyPart, сообщение, MimeBodyPart, MimeMessage, PreencodedMimeBodyPart

public interface Part

Part интерфейс является общим основным интерфейсом для сообщений и BodyParts.

Часть состоит из ряда атрибутов и "Контента".

Атрибуты:

API JavaMail определяет ряд атрибутов стандартного компонента, которые, как полагают, характерны для большинства существующих Почтовых систем. У этих атрибутов есть свой собственный settor и gettor методы. Почтовые системы могут поддерживать другие атрибуты Части также, они представляются как пары значение-имя, где оба имя и значение являются Строками.

Контент:

Тип данных "контента" возвращается getContentType() метод. Система типов MIME используется, чтобы назвать типы данных.

"Контент" Части доступен в различных форматах:

• Как DataHandler - использование getDataHandler() метод. "Контент" Части также доступен через a javax.activation.DataHandler объект. Объект DataHandler позволяет клиентам обнаруживать операции, доступные на контенте, и инстанцировать соответствующего компонента, чтобы выполнить те операции.
• Как входной поток - использование getInputStream() метод. Любые почтово-специфичные кодировки декодируются прежде, чем этот поток возвращается.
• Как объект Java - использование getContent() метод. Этот метод возвращает "контент" как объект Java. Возвращенный объект, конечно, зависит от контента непосредственно. В частности контент "многослойной" Части всегда является Многослойным или подклассом этого. Таким образом, getContent() на "многослойном" типе Часть будет всегда возвращать Многослойное (или подкласс) объект.

Часть обеспечивает writeTo() метод, что потоки его поток байтов в почтово-безопасной форме, подходящей для передачи. Этот поток байтов обычно является агрегацией атрибутов Части и потока байтов ее контента.

Сообщение и BodyPart реализуют интерфейс Части. Отметьте, что в языке MIME, Часть моделирует Объект (RFC 2045, Раздел 2.4).

Автор:

Джон Мани

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

static java.lang.String	ПРИСОЕДИНЕНИЕ Эта часть должна быть представлена как присоединение.
static java.lang.String	ВСТРОЕННЫЙ Эта часть должна быть представлена встроенная.

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

void	addHeader(java.lang.String header_name, java.lang.String header_value) Добавьте это значение к существующим значениям для этого header_name.
java.util.Enumeration	getAllHeaders() Возвратите все заголовки из этой части как Перечисление объектов Заголовка.
java.lang.Object	getContent() Возвратите контент как объект Java.
java.lang.String	getContentType() Возвращает Тип контента контента этой части.
javax.activation.DataHandler	getDataHandler() Возвратите DataHandler для контента в пределах этой части.
java.lang.String	getDescription() Возвратите Строку описания для этой части.
java.lang.String	getDisposition() Возвратите расположение этой части.
java.lang.String	getFileName() Свяжите имя файла с этой частью, если возможный.
java.lang.String[]	getHeader(java.lang.String header_name) Получите все заголовки для этого имени заголовка.
java.io.InputStream	getInputStream() Возвратите входной поток для "контента" этой части.
int	getLineCount() Возвратите число строк в контенте этой части.
java.util.Enumeration	getMatchingHeaders(java.lang.String[] header_names) Возвратите соответствие заголовков из этой части как Перечисление объектов Заголовка.
java.util.Enumeration	getNonMatchingHeaders(java.lang.String[] header_names) Возвратите несоответствие заголовков из этого конверта как Перечисление объектов Заголовка.
int	getSize() Возвратите размер контента этой части в байтах.
boolean	isMimeType(java.lang.String mimeType) Эта Часть имеет указанный тип MIME? Этот метод сравнивается только primaryType и subType.
void	removeHeader(java.lang.String header_name) Удалите все заголовки с этим именем.
void	setContent(Multipart mp) Этот метод устанавливает данный Многослойный объект как контент этого сообщения.
void	setContent(java.lang.Object obj, java.lang.String type) Метод удобства для того, чтобы установить контент этой части.
void	setDataHandler(javax.activation.DataHandler dh) Этот метод обеспечивает механизм, чтобы установить контент этой части.
void	setDescription(java.lang.String description) Установите Строку описания для этой части.
void	setDisposition(java.lang.String disposition) Установите расположение этой части.
void	setFileName(java.lang.String filename) Установите имя файла, связанное с этой частью, если возможный.
void	setHeader(java.lang.String header_name, java.lang.String header_value) Установите значение для этого header_name.
void	setText(java.lang.String text) Метод удобства, который устанавливает данную Строку как контент этой части с типом MIME "текста/плоскости".
void	writeTo(java.io.OutputStream os) Выведите поток байтов для этой Части.

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

ПРИСОЕДИНЕНИЕ

static final java.lang.String ATTACHMENT

Эта часть должна быть представлена как присоединение.

См. Также:

getDisposition(), setDisposition(java.lang.String), Постоянные Значения полей

ВСТРОЕННЫЙ

static final java.lang.String INLINE

Эта часть должна быть представлена встроенная.

См. Также:

getDisposition(), setDisposition(java.lang.String), Постоянные Значения полей

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

getSize

int getSize()
            throws MessagingException

Возвратите размер контента этой части в байтах. Возвратитесь-1, если размер не может быть определен.

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

Возвраты:

размер контента в байтах

Броски:

MessagingException

getLineCount

int getLineCount()
                 throws MessagingException

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

Возвраты:

число строк в контенте.

Броски:

MessagingException

getContentType

java.lang.String getContentType()
                                throws MessagingException

Возвращает Тип контента контента этой части. Нуль возвратов, если Тип контента не мог бы быть определен.

Система типов MIME используется, чтобы назвать Типы контента.

Возвраты:

ContentType этой части

Броски:

MessagingException

См. Также:

DataHandler

isMimeType

boolean isMimeType(java.lang.String mimeType)
                   throws MessagingException

Эта Часть имеет указанный тип MIME? Этот метод сравнивается только primaryType и subType. Параметры типов контента игнорируются.

Например, этот метод возвратится true сравнивая Часть типа контента "текст/плоскость" с "текстом/плоскостью; charset=foobar".

Если subType из mimeType специальный символ '*', тогда подтип игнорируется во время сравнения.

Броски:

MessagingException

getDisposition

java.lang.String getDisposition()
                                throws MessagingException

Возвратите расположение этой части. Расположение описывает, как часть должна быть представлена пользователю. (См. RFC 2183.) Возвращаемое значение, как должны полагать, без отношения случается. Например:

 String disp = part.getDisposition();
 if (disp == null || disp.equalsIgnoreCase(Part.ATTACHMENT))
        // treat as attachment if not first part
 

Возвраты:

расположение этой части, или нуль если неизвестный

Броски:

MessagingException

См. Также:

ATTACHMENT, INLINE, getFileName()

setDisposition

void setDisposition(java.lang.String disposition)
                    throws MessagingException

Установите расположение этой части.

Параметры:

disposition - расположение этой части

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию этого заголовка

IllegalStateException - если эта Часть получается из папки READ_ONLY

См. Также:

ATTACHMENT, INLINE, setFileName(java.lang.String)

getDescription

java.lang.String getDescription()
                                throws MessagingException

Возвратите Строку описания для этой части. Это обычно связывает некоторую дескриптивную информацию с этой частью. Нуль возвратов, если ни один не доступен.

Возвраты:

описание этой части

Броски:

MessagingException

setDescription

void setDescription(java.lang.String description)
                    throws MessagingException

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

Параметры:

description - описание этой части

Броски:

MessagingException

IllegalWriteException - если базовая реализация не поддерживает модификацию этого заголовка

IllegalStateException - если эта Часть получается из папки READ_ONLY

getFileName

java.lang.String getFileName()
                             throws MessagingException

Свяжите имя файла с этой частью, если возможный. Полезный, если эта часть представляет "присоединение", которое было загружено из файла. Имя файла обычно будет простым именем, не включая компоненты каталога.

Возвраты:

Имя файла, чтобы связаться с этой частью

Броски:

MessagingException

setFileName

void setFileName(java.lang.String filename)
                 throws MessagingException

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

Параметры:

filename - Имя файла, чтобы связаться с этой частью

Броски:

IllegalWriteException - если базовая реализация не поддерживает модификацию этого заголовка

IllegalStateException - если эта Часть получается из папки READ_ONLY

MessagingException

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException,
                                          MessagingException

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

Это обычно - метод удобства, который только вызывает DataHandler getInputStream() метод.

Возвраты:

InputStream

Броски:

java.io.IOException - это обычно бросается DataHandler. Сошлитесь на документацию для javax.activation. DataHandler для большего количества деталей.

MessagingException

См. Также:

getDataHandler(), DataHandler.getInputStream()

getDataHandler

javax.activation.DataHandler getDataHandler()
                                            throws MessagingException

Возвратите DataHandler для контента в пределах этой части. DataHandler позволяет клиентам работать на так же как получать контент.

Возвраты:

DataHandler для контента

Броски:

MessagingException

getContent

java.lang.Object getContent()
                            throws java.io.IOException,
                                   MessagingException

Возвратите контент как объект Java. Тип возвращенного объекта, конечно, зависит от контента непосредственно. Например, объект, возвращенный для контента "текста/плоскости", обычно является Строковым объектом. Объект, возвращенный для "многослойного" контента, всегда является Многослойным подклассом. Для типов контента, которые неизвестны системе DataHandler, входной поток возвращается как контент

Это - метод удобства, который только вызывает getContent DataHandler () метод

Возвраты:

Объект

Броски:

MessagingException

java.io.IOException - это обычно бросается DataHandler. Сошлитесь на документацию для javax.activation. DataHandler для большего количества деталей.

См. Также:

DataHandler.getContent()

setDataHandler

void setDataHandler(javax.activation.DataHandler dh)
                    throws MessagingException

Этот метод обеспечивает механизм, чтобы установить контент этой части. DataHandler переносит фактический контент.

Параметры:

dh - DataHandler для контента.

Броски:

MessagingException

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

setContent

void setContent(java.lang.Object obj,
                java.lang.String type)
                throws MessagingException

Метод удобства для того, чтобы установить контент этой части. Часть внутренне обертывает контент в DataHandler.

Отметьте, что DataContentHandler class для указанного типа должен быть доступным реализации JavaMail для этого, чтобы работать правильно. то есть, чтобы сделать setContent(foobar, "application/x-foobar"), DataContentHandler для "application/x-foobar" должен быть установлен. Обратитесь к Платформе Активации Java для получения дополнительной информации.

Параметры:

obj - Объект java.

type - Тип MIME этого объекта.

Броски:

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

MessagingException

setText

void setText(java.lang.String text)
             throws MessagingException

Метод удобства, который устанавливает данную Строку как контент этой части с типом MIME "текста/плоскости".

Параметры:

text - Текст, который является контентом сообщения.

Броски:

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

MessagingException

setContent

void setContent(Multipart mp)
                throws MessagingException

Этот метод устанавливает данный Многослойный объект как контент этого сообщения.

Параметры:

mp - Многослойный объект, который является контентом сообщения

Броски:

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

MessagingException

writeTo

void writeTo(java.io.OutputStream os)
             throws java.io.IOException,
                    MessagingException

Выведите поток байтов для этой Части. Этот поток байтов обычно является aggregration атрибутов Части и соответственно закодированного потока байтов от его 'контента'.

Классы, которые реализуют интерфейс Части, выбирают соответствующий алгоритм кодирования, который будет использоваться.

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

Броски:

java.io.IOException - если ошибка происходит, пишущий в поток или если ошибка сгенерирована javax.activation уровнем.

MessagingException - если ошибка происходит, выбирая данные, которые будут записаны

См. Также:

DataHandler.writeTo(java.io.OutputStream)

getHeader

java.lang.String[] getHeader(java.lang.String header_name)
                             throws MessagingException

Получите все заголовки для этого имени заголовка. Возвраты null если никакие заголовки для этого имени заголовка не доступны.

Параметры:

header_name - имя этого заголовка

Возвраты:

поля значения для всех заголовков с этим именем

Броски:

MessagingException

setHeader

void setHeader(java.lang.String header_name,
               java.lang.String header_value)
               throws MessagingException

Установите значение для этого header_name. Замены весь существующий заголовок оценивают с этим новым значением.

Параметры:

header_name - имя этого заголовка

header_value - значение для этого заголовка

Броски:

MessagingException

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

addHeader

void addHeader(java.lang.String header_name,
               java.lang.String header_value)
               throws MessagingException

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

Параметры:

header_name - имя этого заголовка

header_value - значение для этого заголовка

Броски:

MessagingException

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

removeHeader

void removeHeader(java.lang.String header_name)
                  throws MessagingException

Удалите все заголовки с этим именем.

Параметры:

header_name - имя этого заголовка

Броски:

MessagingException

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

IllegalStateException - если эта Часть получается из папки READ_ONLY

getAllHeaders

java.util.Enumeration getAllHeaders()
                                    throws MessagingException

Возвратите все заголовки из этой части как Перечисление объектов Заголовка.

Возвраты:

перечисление объектов Заголовка

Броски:

MessagingException

getMatchingHeaders

java.util.Enumeration getMatchingHeaders(java.lang.String[] header_names)
                                         throws MessagingException

Возвратите соответствие заголовков из этой части как Перечисление объектов Заголовка.

Возвраты:

перечисление объектов Заголовка

Броски:

MessagingException

getNonMatchingHeaders

java.util.Enumeration getNonMatchingHeaders(java.lang.String[] header_names)
                                            throws MessagingException

Возвратите несоответствие заголовков из этого конверта как Перечисление объектов Заголовка.

Возвраты:

перечисление объектов Заголовка

Броски:

MessagingException