java/src/main/com/google/appengine/api/mail/BounceNotification.java

   1 package com.google.appengine.api.mail;
   2
   3 import javax.annotation.Nullable;
   4 import javax.mail.internet.MimeMessage;
   5
   6 /**
   7  * The {@code BounceNotification} object represents an incoming bounce
   8  * notification.
   9  *
  10  */
  11 public final class BounceNotification {
  12   /**
  13    * The {@code BounceNotification.Details} class describes either the original
  14    * message that caused a bounce, or the notification message describing the
  15    * bounce.
  16    */
  17   public final static class Details {
  18     private final String from;
  19     private final String to;
  20     private final String cc;
  21     private final String bcc;
  22     private final String subject;
  23     private final String text;
  24
  25     private Details(@Nullable String from, @Nullable String to, @Nullable String cc,
  26                     @Nullable String bcc, @Nullable String subject, @Nullable String text) {
  27       this.from = from;
  28       this.to = to;
  29       this.cc = cc;
  30       this.bcc = bcc;
  31       this.subject = subject;
  32       this.text = text;
  33     }
  34
  35     /**
  36      * @return the 'from' field for this detail item.
  37      */
  38     @Nullable
  39     public String getFrom() {
  40       return from;
  41     }
  42
  43     /**
  44      * @return the 'to' field for this detail item.
  45      */
  46     @Nullable
  47     public String getTo() {
  48       return to;
  49     }
  50
  51     /**
  52      * @return the 'cc' field for this detail item.
  53      */
  54     @Nullable
  55     public String getCc() {
  56       return cc;
  57     }
  58
  59     /**
  60      * @return the 'bcc' field for this detail item.
  61      */
  62     @Nullable
  63     public String getBcc() {
  64       return bcc;
  65     }
  66
  67     /**
  68      * @return the 'subject' field for this detail item.
  69      */
  70     @Nullable
  71     public String getSubject() {
  72       return subject;
  73     }
  74
  75     /**
  76      * @return the 'text' field for this detail item.
  77      */
  78     @Nullable
  79     public String getText() {
  80       return text;
  81     }
  82   }
  83
  84   static class DetailsBuilder {
  85     private String from;
  86     private String to;
  87     private String cc;
  88     private String bcc;
  89     private String subject;
  90     private String text;
  91
  92     public Details build() {
  93       return new Details(from, to, cc, bcc, subject, text);
  94     }
  95
  96     public DetailsBuilder withFrom(@Nullable String from) {
  97       this.from = from;
  98       return this;
  99     }
 100
 101     public DetailsBuilder withTo(@Nullable String to) {
 102       this.to = to;
 103       return this;
 104     }
 105
 106     public DetailsBuilder withCc(@Nullable String cc) {
 107       this.cc = cc;
 108       return this;
 109     }
 110
 111     public DetailsBuilder withBcc(@Nullable String bcc) {
 112       this.bcc = bcc;
 113       return this;
 114     }
 115
 116     public DetailsBuilder withSubject(@Nullable String subject) {
 117       this.subject = subject;
 118       return this;
 119     }
 120
 121     public DetailsBuilder withText(@Nullable String text) {
 122       this.text = text;
 123       return this;
 124     }
 125   }
 126
 127   static class BounceNotificationBuilder {
 128     public BounceNotification build() {
 129       return new BounceNotification(rawMessage, original, notification);
 130     }
 131
 132     public BounceNotificationBuilder withRawMessage(MimeMessage rawMessage) {
 133       this.rawMessage = rawMessage;
 134       return this;
 135     }
 136
 137     public BounceNotificationBuilder withOriginal(BounceNotification.Details original) {
 138       this.original = original;
 139       return this;
 140     }
 141
 142     public BounceNotificationBuilder withNotification(BounceNotification.Details notification) {
 143       this.notification = notification;
 144       return this;
 145     }
 146
 147     private MimeMessage rawMessage;
 148     private BounceNotification.Details original;
 149     private BounceNotification.Details notification;
 150   }
 151
 152   BounceNotification(@Nullable MimeMessage rawMessage, @Nullable Details original,
 153                      @Nullable Details notification) {
 154     this.rawMessage = rawMessage;
 155     this.original = original;
 156     this.notification = notification;
 157   }
 158
 159   /**
 160    * @return the original MIME message that caused the bounce.
 161    */
 162   @Nullable
 163   public final MimeMessage getRawMessage() {
 164     return rawMessage;
 165   }
 166
 167   /**
 168    * @return the parsed Details of the original message.
 169    */
 170   @Nullable
 171   public final Details getOriginal() {
 172     return original;
 173   }
 174
 175   /**
 176    * @return the parsed Details describing the bounce.
 177    */
 178   @Nullable
 179   public final Details getNotification() {
 180     return notification;
 181   }
 182
 183   private final MimeMessage rawMessage;
 184   private final Details original;
 185   private final Details notification;
 186 }