nylas
    Preparing search index...

    Interface AttachmentUploadSession

    Upload session returned when creating a large-attachment upload session. Corresponds to the data object in the create-session API response.

    interface AttachmentUploadSession {
        attachmentId: string;
        contentType: string;
        expiresAt: string;
        filename: string;
        grantId: string;
        headers: Record<string, string>;
        maxSize: number;
        method: string;
        size: number;
        url: string;
    }
    Index

    Properties

    attachmentId contentType expiresAt filename grantId headers maxSize method size url

    Properties

    attachmentId: string

    Unique identifier for the upload session. Use when completing the session and when referencing the attachment in send or draft.

    contentType: string

    MIME type of the file.

    expiresAt: string

    When the upload session expires (RFC 3339).

    filename: string

    Name of the file.

    grantId: string

    The grant ID the upload session belongs to.

    headers: Record<string, string>

    Headers to include when uploading to AttachmentUploadSession.url.

    maxSize: number

    Maximum allowed file size in bytes.

    method: string

    HTTP method to use when uploading to AttachmentUploadSession.url. Always PUT.

    size: number

    Expected file size in bytes, echoing the request. 0 if size was omitted on creation.

    url: string

    Pre-signed URL to upload file bytes (no Nylas auth header on this request).

    Settings

    Member Visibility

    On This Page

    Properties