com.mailosaur.models.MessageSummary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mailosaur-java Show documentation
Mailosaur Java Bindings for Email Test Automation
There is a newer version: 8.1.0
package com.mailosaur.models;

import java.util.List;

import com.google.api.client.util.DateTime;
import com.google.api.client.util.Key;

/**
 * The MessageSummary model.
 */
public class MessageSummary extends BaseModel {
    /**
     * Unique identifier for the message.
     */
    @Key
    private String id;

    /**
     * The type of message.
     */
    @Key
    private String type;

    /**
     * The sender of the message.
     */
    @Key
    private List from;

    /**
     * The recipients of the message.
     */
    @Key
    private List to;

    /**
     * Carbon-copied recipients for email messages.
     */
    @Key
    private List cc;

    /**
     * Blind carbon-copied recipients for email messages.
     */
    @Key
    private List bcc;

    /**
     * The date/time that this message was received by Mailosaur.
     */
    @Key
    private DateTime received;

    /**
     * The subject of the message.
     */
    @Key
    private String subject;

    /**
     * A short, summarized version of the message content.
     */
	@Key
    private String summary;

    /**
     * The number of attachments associated with the message.
     */
	@Key
    private Integer attachments;

    /**
     * Identifier for the server in which the message is located.
     */
    @Key
    private String server;

    /**
     * Get the unique identifier for the message.
     *
     * @return Unique identifier for the message.
     */
    public String id() {
        return this.id;
    }

    /**
     * Gets the type of message.
     *
     * @return The type of message.
     */
    public String type() {
        return this.type;
    }

    /**
     * Gets the sender of the message.
     *
     * @return The sender of the message.
     */
    public List from() {
        return this.from;
    }

    /**
     * Gets the recipients of the message.
     *
     * @return The recipients of the message.
     */
    public List to() {
        return this.to;
    }

    /**
     * Gets the carbon-copied recipients for email messages.
     *
     * @return The carbon-copied recipients for email messages.
     */
    public List cc() {
        return this.cc;
    }

    /**
     * Gets the blind carbon-copied recipients for email messages.
     *
     * @return The blind carbon-copied recipients for email messages.
     */
    public List bcc() {
        return this.bcc;
    }

    /**
     * Gets the date/time that this message was received by Mailosaur.
     *
     * @return The date/time that this message was received by Mailosaur.
     */
    public DateTime received() {
        return this.received;
    }

    /**
     * Gets the subject of the message.
     *
     * @return The subject of the message.
     */
    public String subject() {
        return nullableString(this.subject);
    }

    /**
     * Gets a short, summarized version of the message content.
     *
     * @return A short, summarized version of the message content.
     */
    public String summary() {
        return nullableString(this.summary);
    }

    /**
     * Gets the number of attachments associated with the message.
     *
     * @return The number of attachments associated with the message.
     */
    public Integer attachments() {
        return this.attachments;
    }

    /**
     * Gets the identifier for the server in which the message is located.
     *
     * @return Identifier for the server in which the message is located.
     */
    public String server() {
        return this.server;
    }

}