Package africa.sendbyte.emails

Class Email

java.lang.Object
africa.sendbyte.emails.Email
public final class Email extends Object
A sent email as returned by Emails.send(africa.sendbyte.emails.SendEmailRequest), Emails.get(java.lang.String), and the items of Emails.list().

Send and list responses populate a summary subset of these fields; a Emails.get(String) response additionally includes the rendered html/text bodies and the full events timeline.

  • Constructor Details

    • Email

      public Email()

  • Method Details

    • getId

      public String getId()
      Unique email identifier (prefixed em_).

    • setId

      public void setId(String id)

    • getFrom

      public String getFrom()

    • setFrom

      public void setFrom(String from)

    • getTo

      public List<String> getTo()

    • setTo

      public void setTo(List<String> to)

    • getSubject

      public String getSubject()

    • setSubject

      public void setSubject(String subject)

    • getStatus

      public String getStatus()
      Raw status string, e.g. queued. See status() for the typed value.

    • setStatus

      public void setStatus(String status)

    • status

      public EmailStatus status()
      The status as a typed enum, mapping unknown values to EmailStatus.UNKNOWN.

    • isSandbox

      public boolean isSandbox()

    • setSandbox

      public void setSandbox(boolean sandbox)

    • getHtml

      public String getHtml()
      Rendered HTML body. Present on Emails.get(java.lang.String); null on send/list responses.

    • setHtml

      public void setHtml(String html)

    • getText

      public String getText()

    • setText

      public void setText(String text)

    • getScheduledAt

      public String getScheduledAt()
      ISO 8601 scheduled send time, or null for immediate delivery.

    • setScheduledAt

      public void setScheduledAt(String scheduledAt)

    • getCreatedAt

      public String getCreatedAt()

    • setCreatedAt

      public void setCreatedAt(String createdAt)

    • getEvents

      public List<EmailEvent> getEvents()
      Chronological lifecycle timeline. Present on Emails.get(java.lang.String); null otherwise.

    • setEvents

      public void setEvents(List<EmailEvent> events)