IMAP サーバー上のフォルダー操作

フォルダー情報の取得

Aspose.Email を使用すると、IMAP サーバーからフォルダー情報を取得するのは非常に簡単です。次を呼び出します listFolders() メソッド（ ImapClient クラス。次のオブジェクトを返します IMAPフォルダー情報コレクション型。このコレクションを反復処理し、ループ内で個々のフォルダー情報を取得します。メソッドはオーバーロードされており、フォルダー名をパラメーターとして渡すことでサブフォルダーの一覧を取得できます。以下のコードスニペットは、説明された Aspose.Email メソッドを使用して IMAP サーバーからフォルダー情報を取得する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Get all folders in the currently subscribed folder
ImapFolderInfoCollection folderInfoColl = client.listFolders();

// Iterate through the collection to get folder info one by one
for (ImapFolderInfo folderInfo : (Iterable<ImapFolderInfo>) folderInfoColl) {
    // Folder name and get New messages in the folder
    System.out.println("Folder name is " + folderInfo.getName());
    ImapFolderInfo folderExtInfo = client.getFolderInfo(folderInfo.getName());
    System.out.println("New message count: " + folderExtInfo.getNewMessageCount());
    System.out.println("Is it readonly? " + folderExtInfo.getReadOnly());
    System.out.println("Total number of messages " + folderExtInfo.getTotalMessageCount());
}

フォルダーの削除と名前変更

IMAP サーバー上のフォルダーは、Aspose.Email を使用して 1 行で削除または名前変更できます：

この deleteFolder() メソッドはフォルダー名をパラメーターとして受け取ります。
以下の場合 renameFolder() メソッドでは、現在のフォルダー名と新しいフォルダー名を渡す必要があります。以下のコードスニペットは、IMAP サーバーからフォルダーを削除し、フォルダー名を変更する方法を示しています。各操作は 1 行のコードで実行できます。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Delete a folder and Rename a folder
client.deleteFolder("foldername");
client.renameFolder("foldername", "newfoldername");

フォルダーに新しいメッセージを追加

次を使用してフォルダーに新しいメッセージを追加できます MailMessage および ImapClient クラス。まず、作成します MailMessage 件名、宛先、差出人の値を提供してオブジェクトを作成します。その後、フォルダーにサブスクライブし、メッセージを追加します。以下のコードスニペットは、フォルダーに新しいメッセージを追加する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create a message
MailMessage msg = new MailMessage("user@domain1.com", "user@domain2.com", "subject", "message");

// Subscribe to the Inbox folder and Append the newly created message
client.selectFolder(ImapFolderInfo.IN_BOX);
client.subscribeFolder(client.getCurrentFolder().getName());
client.appendMessage(client.getCurrentFolder().getName(), msg);

MultiConnection 対応で複数メッセージを追加

次を使用して複数のメッセージを追加できます appendMessages が提供するメソッド ImapClient クラス。 appendMessages メソッドはリストを受け取ります MailMessage フォルダーがパラメーターとして提供されていない場合、現在のフォルダーに追加します。ImapClient は重い処理向けに MultiConnection モードもサポートしています。以下のコードスニペットは、MultiConnection モードを使用して複数のメッセージを追加する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

List<MailMessage> messages = new ArrayList<MailMessage>();
for (int i = 0; i < 20; i++) {
    MailMessage message = new MailMessage("<EMAIL ADDRESS>", "<EMAIL ADDRESS>", "Test Message - " + UUID.randomUUID().toString(), "IMAP Group Append with MultiConnection");
    messages.add(message);
}

imapClient.setConnectionsQuantity(5);
imapClient.setUseMultiConnection(MultiConnectionMode.Enable);
imapClient.appendMessages(messages);

マルチコネクションモードの使用は、パフォーマンス向上を保証しないことに注意してください。

メッセージを別のメールボックスフォルダーへ移動

Aspose.Email for Java は、次のものを使用してメッセージをあるメールボックスフォルダーから別のフォルダーへ移動できます。 ImapClient API。 moveMessage このメソッドはメッセージの一意 ID と宛先フォルダー名を使用してメッセージを宛先フォルダーへ移動します。以下のコードスニペットは、メッセージを別のメールボックスフォルダーへ移動する方法を示します。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// This example shows how to move a message from one folder of a mailbox to another one using the ImapClient API of Aspose.Email for Java
// Available from Aspose.Email for Java onwards
// -------------- Available API Overload Members --------------
// void ImapClient.moveMessage(IConnection iConnection, int sequenceNumber, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(IConnection iConnection, String uniqueId, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(int sequenceNumber, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(String uniqueId, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(IConnection iConnection, int sequenceNumber, String folderName)
// void ImapClient.moveMessage(IConnection iConnection, String uniqueId, String folderName)
// void ImapClient.moveMessage(int sequenceNumber, String folderName)
// void ImapClient.moveMessage(String uniqueId, String folderName)

final ImapClient client = new ImapClient("host.domain.com", 993, "username", "password");
try {
    String folderName = "EMAILNET-35151";
    if (!client.existFolder(folderName))
        client.createFolder(folderName);
    try {
        MailMessage message = new MailMessage("from@domain.com", "to@domain.com", "EMAILNET-35151 - " + UUID.randomUUID(),
                "EMAILNET-35151 ImapClient: Provide option to Move Message");
        client.selectFolder(ImapFolderInfo.IN_BOX);
        // Append the new message to Inbox folder
        String uniqueId = client.appendMessage(ImapFolderInfo.IN_BOX, message);
        ImapMessageInfoCollection messageInfoCol1 = client.listMessages();
        System.out.println(messageInfoCol1.size());
        // Now move the message to the folder EMAILNET-35151
        client.moveMessage(uniqueId, folderName);
        client.commitDeletes();
        // Verify that the message was moved to the new folder
        client.selectFolder(folderName);
        messageInfoCol1 = client.listMessages();
        System.out.println(messageInfoCol1.size());
        // Verify that the message was moved from the Inbox
        client.selectFolder(ImapFolderInfo.IN_BOX);
        messageInfoCol1 = client.listMessages();
        System.out.println(messageInfoCol1.size());
    } finally {
        try {
            client.deleteFolder(folderName);
        } catch (java.lang.RuntimeException e) {
        }
    }
} finally {
    if (client != null)
        client.dispose();
}

別のメールボックスフォルダーへメッセージをコピー

Aspose.Email API は、メールボックスフォルダー間でメッセージをコピーする機能を提供します。単一または複数のメッセージを次を使用してコピーできます copyMessage および copyMessages メソッド。 copyMessages メソッドは、メールボックスのソースフォルダーから宛先メールボックスフォルダーへ複数のメッセージをコピーする機能を提供します。以下のコードスニペットは、メッセージを別のメールボックスフォルダーにコピーする方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
final ImapClient client = new ImapClient("exchange.aspose.com", "username", "password");
try {
    // Create the destination folder
    String folderName = "EMAILNET-35242";
    if (!client.existFolder(folderName))
        client.createFolder(folderName);
    try {
        // Append a couple of messages to the server
        MailMessage message1 = new MailMessage("asposeemail.test3@aspose.com", "asposeemail.test3@aspose.com", "EMAILNET-35242 - " + UUID.randomUUID(),
                "EMAILNET-35242 Improvement of copy method.Add ability to 'copy' multiple messages per invocation.");
        String uniqueId1 = client.appendMessage(message1);

        MailMessage message2 = new MailMessage("asposeemail.test3@aspose.com", "asposeemail.test3@aspose.com", "EMAILNET-35242 - " + UUID.randomUUID(),
                "EMAILNET-35242 Improvement of copy method.Add ability to 'copy' multiple messages per invocation.");
        String uniqueId2 = client.appendMessage(message2);

        // Verify that the messages have been added to the mailbox
        client.selectFolder(ImapFolderInfo.IN_BOX);
        ImapMessageInfoCollection msgsColl = client.listMessages();
        for (ImapMessageInfo msgInfo : msgsColl)
            System.out.println(msgInfo.getSubject());

        // Copy multiple messages using the CopyMessages command and Verify that messages are copied to the destination folder
        client.copyMessagesByUids(Arrays.asList(uniqueId1, uniqueId2), folderName);

        client.selectFolder(folderName);
        msgsColl = client.listMessages();
        for (ImapMessageInfo msgInfo : msgsColl)
            System.out.println(msgInfo.getSubject());
    } finally {
        try {
            client.deleteFolder(folderName);
        } catch (java.lang.RuntimeException e) {
        }
    }
} finally {
    if (client != null)
        client.dispose();
}

特殊用途メールボックスフォルダーの操作

一部の IMAP メッセージストアには、下書きや送信済みメッセージを保持するための特殊用途メールボックスが含まれます。多くのメールクライアントは、下書きや送信済みメッセージをどこに保存するか指定できますが、設定にはサーバーがそれらの目的のために用意したメールボックスをユーザーが知っている必要があります。Aspose.Email は、次を使用してこれらの特殊用途メールボックスを特定できます ImapMailboxInfo クラスは、これらを扱いやすくします。以下のコードサンプルは、次を使用してこれらの特殊用途メールボックスにアクセスする方法を示しています ImapMailboxInfo クラス。

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

ImapMailboxInfo mailboxInfo = imapClient.getMailboxInfo();
System.out.println(mailboxInfo.getInbox());
System.out.println(mailboxInfo.getDraftMessages());
System.out.println(mailboxInfo.getJunkMessages());
System.out.println(mailboxInfo.getSentMessages());
System.out.println(mailboxInfo.getTrash());

サーバーからメッセージを削除 ImapClient を非同期で使用する