messages

Fields = Literal['standard', 'include_headers'] module-attribute

Literal representing which headers to include with a message.

ListMessagesQueryParams = TypedDict('ListMessagesQueryParams', {None: get_type_hints(ListQueryParams), 'subject': NotRequired[str], 'any_email': NotRequired[str], 'from': NotRequired[str], 'to': NotRequired[str], 'cc': NotRequired[str], 'bcc': NotRequired[str], 'in': NotRequired[str], 'unread': NotRequired[bool], 'starred': NotRequired[bool], 'thread_id': NotRequired[str], 'received_before': NotRequired[int], 'received_after': NotRequired[int], 'has_attachment': NotRequired[bool], 'fields': NotRequired[Fields], 'search_query_native': NotRequired[str]}) module-attribute

Query parameters for listing messages.

Attributes:

Name	Type	Description
subject		Return messages with matching subject.
any_email		Return messages that have been sent or received by this comma-separated list of email addresses.
from		Return messages sent from this email address.
to		Return messages sent to this email address.
cc		Return messages cc'd to this email address.
bcc		Return messages bcc'd to this email address.
in		Return messages in this specific folder or label, specified by ID.
unread		Filter messages by unread status.
starred		Filter messages by starred status.
thread_id		Filter messages by thread_id.
received_before		Return messages with received dates before received_before.
received_after		Return messages with received dates after received_after.
has_attachment		Filter messages by whether they have an attachment.
fields		Specify "include_headers" to include headers in the response. "standard" is the default.
search_query_native		A native provider search query for Google or Microsoft.
limit	NotRequired[int]	The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.
page_token	NotRequired[str]	An identifier that specifies which page of data to return. This value should be taken from a ListResponse object's next_cursor parameter.

Attachment dataclass

An attachment on a message.

Attributes:

Name	Type	Description
id	str	Globally unique object identifier.
size	int	Size of the attachment in bytes.
filename	Optional[str]	Name of the attachment.
content_type	Optional[str]	MIME type of the attachment.

Source code in nylas/models/messages.py

@dataclass_json
@dataclass
class Attachment:
    """
    An attachment on a message.

    Attributes:
        id: Globally unique object identifier.
        size: Size of the attachment in bytes.
        filename: Name of the attachment.
        content_type: MIME type of the attachment.
    """

    id: str
    size: int
    filename: Optional[str] = None
    content_type: Optional[str] = None

FindMessageQueryParams

Bases: TypedDict

Query parameters for finding a message.

Attributes:

Name	Type	Description
fields	NotRequired[Fields]	Specify "include_headers" to include headers in the response. "standard" is the default.

Source code in nylas/models/messages.py

class FindMessageQueryParams(TypedDict):

    """Query parameters for finding a message.

    Attributes:
        fields: Specify "include_headers" to include headers in the response. "standard" is the default.
    """

    fields: NotRequired[Fields]

Message dataclass

A Message object.

Attributes:

Name	Type	Description
id	str	Globally unique object identifier.
grant_id	str	The grant that this message belongs to.
thread_id	str	The thread that this message belongs to.
subject	str	The subject of the message.
from_	List[Participant]	The sender of the message.
to	List[Participant]	The recipients of the message.
cc	Optional[List[Participant]]	The CC recipients of the message.
bcc	Optional[List[Participant]]	The BCC recipients of the message.
reply_to	Optional[List[Participant]]	The reply-to recipients of the message.
date	datetime	The date the message was received.
unread	bool	Whether the message is unread.
starred	bool	Whether the message is starred.
snippet	str	A snippet of the message body.
body	str	The body of the message.
attachments	Optional[List[Attachment]]	The attachments on the message.
folders	Optional[List[str]]	The folders that the message is in.
headers	Optional[List[str]]	The headers of the message.

Source code in nylas/models/messages.py

@dataclass_json
@dataclass
class Message:
    """
    A Message object.

    Attributes:
        id: Globally unique object identifier.
        grant_id: The grant that this message belongs to.
        thread_id: The thread that this message belongs to.
        subject: The subject of the message.
        from_: The sender of the message.
        to: The recipients of the message.
        cc: The CC recipients of the message.
        bcc: The BCC recipients of the message.
        reply_to: The reply-to recipients of the message.
        date: The date the message was received.
        unread: Whether the message is unread.
        starred: Whether the message is starred.
        snippet: A snippet of the message body.
        body: The body of the message.
        attachments: The attachments on the message.
        folders: The folders that the message is in.
        headers: The headers of the message.
    """

    id: str
    grant_id: str
    thread_id: str
    subject: str

    from_: List[Participant] = field(metadata=config(field_name="from"))
    to: List[Participant]

    date: datetime

    unread: bool
    starred: bool

    snippet: str
    body: str

    bcc: Optional[List[Participant]] = None
    cc: Optional[List[Participant]] = None
    reply_to: Optional[List[Participant]] = None
    attachments: Optional[List[Attachment]] = None
    folders: Optional[List[str]] = None
    headers: Optional[List[str]] = None

Participant dataclass

A participant in a message.

Attributes:

Name	Type	Description
name	Optional[str]	Participant's name
email	str	Participant's email

Source code in nylas/models/messages.py

@dataclass_json
@dataclass
class Participant:
    """
    A participant in a message.

    Attributes:
        name: Participant's name
        email: Participant's email
    """

    email: str
    name: Optional[str] = None

UpdateMessageRequest

Bases: TypedDict

Request payload for updating a message.

Attributes:

Name	Type	Description
starred	NotRequired[bool]	The message's starred status
unread	NotRequired[bool]	The message's unread status
folders	NotRequired[bool]	The message's folders
metadata	NotRequired[Dict[str, Any]]	A list of key-value pairs storing additional data

Source code in nylas/models/messages.py

class UpdateMessageRequest(TypedDict):

    """
    Request payload for updating a message.

    Attributes:
        starred: The message's starred status
        unread: The message's unread status
        folders: The message's folders
        metadata: A list of key-value pairs storing additional data
    """

    unread: NotRequired[bool]
    starred: NotRequired[bool]
    folder: NotRequired[List[str]]
    metadata: NotRequired[Dict[str, Any]]