Save an IMAP Attachment to a File

See more IMAP Examples

Demonstrates the Chilkat Imap.FetchAttachment method, which downloads one attachment from the IMAP server and saves it to the filesystem. The first argument is the Email, the second is the zero-based attachment index, and the third is the file path to write. This example fetches a message headers-only, inspects its attachments without downloading them, and then downloads a specific attachment on demand.

Note: The output path is relative to the application's current working directory. Chilkat does not create missing parent directories, so qa_output/ must already exist.

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    //  Demonstrates the Imap.FetchAttachment method, which downloads one attachment from the IMAP
    //  server and saves it to a file.  The 1st argument is the Email, the 2nd is the zero-based
    //  attachment index, and the 3rd is the file path to write.
    //  
    //  The compelling use case: fetch a message headers-only, inspect its attachments without
    //  downloading them, and then download just the attachment(s) you want.

    CkImap imap = new CkImap();

    imap.put_Ssl(true);
    imap.put_Port(993);

    success = imap.Connect("imap.example.com");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    success = imap.Login("user@example.com","myPassword");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    success = imap.SelectMailbox("Inbox");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    //  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
    //  metadata describing the attachments is present, so the attachment info methods still work.
    boolean headersOnly = true;
    boolean useUid = false;
    int seqNum = 1;
    CkEmail email = new CkEmail();
    success = imap.FetchEmail(headersOnly,seqNum,useUid,email);
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    //  Even though the body was not downloaded, the attachment count and names are available.
    int numAttach = imap.GetMailNumAttach(email);
    Log.i(TAG, "Attachments: " + String.valueOf(numAttach));

    if (numAttach > 0) {
        //  Get the attachment's original filename and use it for the saved file.
        String fname = imap.getMailAttachFilename(email,0);
        if (imap.get_LastMethodSuccess() == false) {
            Log.i(TAG, imap.lastErrorText());
            return;
            }

        //  Build the output path "qa_output/<filename>".
        CkStringBuilder sbPath = new CkStringBuilder();
        sbPath.Append("qa_output/");
        sbPath.Append(fname);
        String savePath = sbPath.getAsString();

        //  Download just the first attachment (index 0) from the server and save it to that path.
        success = imap.FetchAttachment(email,0,savePath);
        if (success == false) {
            Log.i(TAG, imap.lastErrorText());
            return;
            }

        Log.i(TAG, "Saved attachment: " + savePath);
        }

    success = imap.Disconnect();
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}