com.docomo_um.module.net
クラス POPClient

java.lang.Object
  com.docomo_um.module.net.POPClient

public class POPClient
extends java.lang.Object

POPサーバを操作するクラスです。

POPサーバを操作する際、まず始めに login() を使用してサーバにログインします。
POPサーバのログイン後にPOPサーバの操作(receiveTotalMailNumbers()、receiveMailSize(int)、receiveMail(int))を行います。
POPサーバの操作が完了した後、logout() を使用してサーバからログアウトします。

メソッドの概要

void	deleteMail(int mailNumber) POPサーバからメールを削除します。
void	login() POPサーバにログインします。
void	logout() POPサーバからログアウトします。
Mail	receiveHeader(int mailNumber) メールのヘッダを取得します。
Mail	receiveMail(int mailNumber) POPサーバからメールを取得します。
long	receiveMailSize(int mailNumber) POPサーバからメールのサイズ(byte)を取得します。
int	receiveTotalMailNumbers() POPサーバにあるメールの総数を取得します。

クラス java.lang.Object から継承されたメソッド

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

メソッドの詳細

login

public void login()
           throws MailException,
                  CommunicationFailureException,
                  SecureHandshakeException,
                  IllegalSettingException

POPサーバにログインします。
POPサーバの操作を行う前に本メソッドにてサーバへログインします。
尚、ログインせずにPOPサーバを操作するメソッドを使用することは出来ません。
ログインせずに操作を行った場合は例外が発生します。

例外:

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

SecureHandshakeException - POP over SSLで、POPサーバとのハンドシェイクに失敗した場合に発生します。

IllegalSettingException - 認証時にアカウントまたはパスワードが異なる場合に発生します。

logout

public void logout()
            throws MailException,
                   CommunicationFailureException

POPサーバからログアウトします。
POPサーバの操作完了後に、本メソッドにてサーバからログアウトします。

例外:

java.lang.IllegalStateException - ログインしないで本メソッドをコールした場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

deleteMail

public void deleteMail(int mailNumber)
                throws MailException,
                       CommunicationFailureException

POPサーバからメールを削除します。
n通目のメールのメール番号は、n-1です。例えば、一番最初のメールのメール番号は0です。

パラメータ:

mailNumber - 削除するメールのメール番号(0～)を指定します。

例外:

java.lang.IllegalArgumentException - mailNumberが範囲外、または削除済みの場合に発生します。

java.lang.IllegalStateException - ログインせずにこのメソッドを呼び出した場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

関連項目:

receiveTotalMailNumbers()

receiveMailSize

public long receiveMailSize(int mailNumber)
                     throws MailException,
                            CommunicationFailureException

POPサーバからメールのサイズ(byte)を取得します。
n通目のメールのメール番号は、n-1です。例えば、一番最初のメールのメール番号は0です。

パラメータ:

mailNumber - サイズを取得するメールのメール番号(0～)を指定します。

戻り値:

メールのサイズ(byte)を返します。

例外:

java.lang.IllegalArgumentException - mailNumberが範囲外、または削除済みの場合に発生します。

java.lang.IllegalStateException - ログインせずにこのメソッドを呼び出した場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

関連項目:

receiveTotalMailNumbers()

receiveMail

public Mail receiveMail(int mailNumber)
                 throws MailException,
                        CommunicationFailureException

POPサーバからメールを取得します。
n通目のメールのメール番号は、n-1です。例えば、一番最初のメールのメール番号は0です。 ヘッダ部のみを取得したい場合はreceiveHeader(int)を呼んでください。

受信出来るメールサイズはヘッダ部を含めて10KBまでです。その為、受信するメールが10KBを超えた場合、10KBまで受信を行い、それ以降は破棄されます。

パラメータ:

mailNumber - 取得するメールのメール番号(0～)を指定します。

戻り値:

メールを返します。

例外:

java.lang.IllegalArgumentException - mailNumberが範囲外、または削除済みの場合に発生します。

java.lang.IllegalStateException - ログインせずにこのメソッドを呼び出した場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

関連項目:

receiveTotalMailNumbers(), receiveHeader(int), receiveMailSize(int)

receiveHeader

public Mail receiveHeader(int mailNumber)
                   throws MailException,
                          CommunicationFailureException

メールのヘッダを取得します。
n通目のメールのメール番号は、n-1です。例えば、一番最初のメールのメール番号は0です。

このメソッドでは以下の情報を取得します。

• Fromアドレス
• Toアドレス
• Ccアドレス
• サブジェクト

ヘッダと本文の両方を取得したい場合はreceiveMail(int)を呼んでください。
また受信出来るメールサイズはヘッダ部を含めて10KBまでです。ヘッダ部のみで10KBを超えた場合、10KBまで受信を行い、それ以降は破棄されます。

パラメータ:

mailNumber - 取得するメールのメール番号(0～)を指定します。

戻り値:

メールを返します。

例外:

java.lang.IllegalArgumentException - mailNumberが範囲外、または削除済みの場合に発生します。

java.lang.IllegalStateException - ログインせずにこのメソッドを呼び出した場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

関連項目:

receiveTotalMailNumbers(), receiveMail(int), receiveMailSize(int)

receiveTotalMailNumbers

public int receiveTotalMailNumbers()
                            throws MailException,
                                   CommunicationFailureException

POPサーバにあるメールの総数を取得します。

戻り値:

メールの総数を返します。

例外:

java.lang.IllegalStateException - ログインせずにこのメソッドを呼び出した場合に発生します。

MailException - サーバとの通信でエラーが起こった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。