Email

Email document (*.eml) operations.

AsFile

Converts Email model to a specified format and returns as a file. Returns a File. Requires:

request

Email model and format to convert. Type: EmailAsFileRequest.

var request = new EmailAsFileRequest
{
    Value = new EmailDto
    {
        Attachments = new List<Attachment>
        {
            new Attachment
            {
                Name = "some-file.txt",
                Base64Data = "U29tZSBmaWxlIGNvbnRlbnQ="
            }
        },
        Body = "Some body",
        BodyType = "Html",
        DeliveryNotificationOptions = new List<EmailDeliveryNotificationOptions>
        {
            "OnSuccess",
            "Delay"
        },
        From = new MailAddress
        {
            DisplayName = "From Address",
            Address = "from@aspose.com"
        },
        HtmlBody = "<b>Some body</b>",
        IsBodyHtml = true,
        IsDraft = true,
        Subject = "Re: Some subject",
        To = new List<MailAddress>
        {
            new MailAddress
            {
                DisplayName = "To Address",
                Address = "to@aspose.com"
            }
        }
    }
};

Java

EmailAsFileRequest request = Models.emailAsFileRequest()
    .value(Models.emailDto()
        .attachments(Arrays.<Attachment>asList(
            Models.attachment()
                .name("some-file.txt")
                .base64Data("U29tZSBmaWxlIGNvbnRlbnQ=")
                .build()))
        .body("Some body")
        .bodyType("Html")
        .deliveryNotificationOptions(Arrays.<EmailDeliveryNotificationOptions>asList(
            "OnSuccess",
            "Delay"))
        .from(Models.mailAddress()
            .displayName("From Address")
            .address("from@aspose.com")
            .build())
        .htmlBody("<b>Some body</b>")
        .isBodyHtml(true)
        .isDraft(true)
        .subject("Re: Some subject")
        .to(Arrays.<MailAddress>asList(
            Models.mailAddress()
                .displayName("To Address")
                .address("to@aspose.com")
                .build()))
        .build())
    .build();

Python

request = models.EmailAsFileRequest(
    value=models.EmailDto(
        attachments=[
            models.Attachment(
                name='some-file.txt',
                base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')],
        body='Some body',
        body_type='Html',
        delivery_notification_options=[
            'OnSuccess',
            'Delay'],
        _from=models.MailAddress(
            display_name='From Address',
            address='from@aspose.com'),
        html_body='<b>Some body</b>',
        is_body_html=True,
        is_draft=True,
        subject='Re: Some subject',
        to=[
            models.MailAddress(
                display_name='To Address',
                address='to@aspose.com')]))

Ruby

request = EmailAsFileRequest.new(
  value: EmailDto.new(
    attachments: [
      Attachment.new(
        name: 'some-file.txt',
        base64_data: 'U29tZSBmaWxlIGNvbnRlbnQ=')],
    body: 'Some body',
    body_type: 'Html',
    delivery_notification_options: [
      'OnSuccess',
      'Delay'],
    from: MailAddress.new(
      display_name: 'From Address',
      address: 'from@aspose.com'),
    html_body: '<b>Some body</b>',
    is_body_html: true,
    is_draft: true,
    subject: 'Re: Some subject',
    to: [
      MailAddress.new(
        display_name: 'To Address',
        address: 'to@aspose.com')]))

Typescript

let request = Models.emailAsFileRequest()
    .value(Models.emailDto()
        .attachments([
            Models.attachment()
                .name('some-file.txt')
                .base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
                .build()])
        .body('Some body')
        .bodyType('Html')
        .deliveryNotificationOptions([
            'OnSuccess',
            'Delay'])
        .from(Models.mailAddress()
            .displayName('From Address')
            .address('from@aspose.com')
            .build())
        .htmlBody('<b>Some body</b>')
        .isBodyHtml(true)
        .isDraft(true)
        .subject('Re: Some subject')
        .to([
            Models.mailAddress()
                .displayName('To Address')
                .address('to@aspose.com')
                .build()])
        .build())
    .build();

PHP

$request = Models::emailAsFileRequest()
    ->value(Models::emailDto()
        ->attachments(array(
            Models::attachment()
                ->name('some-file.txt')
                ->base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
                ->build()))
        ->body('Some body')
        ->bodyType('Html')
        ->deliveryNotificationOptions(array(
            'OnSuccess',
            'Delay'))
        ->from(Models::mailAddress()
            ->displayName('From Address')
            ->address('from@aspose.com')
            ->build())
        ->htmlBody('<b>Some body</b>')
        ->isBodyHtml(true)
        ->isDraft(true)
        ->subject('Re: Some subject')
        ->to(array(
            Models::mailAddress()
                ->displayName('To Address')
                ->address('to@aspose.com')
                ->build()))
        ->build())
    ->build();

var result = await api.Email.AsFileAsync(request);

Java

byte[] result = api.email().asFile(request);

Python

result = api.email.as_file(request)

Ruby

result = api.email.as_file(request)

Typescript

let result = await api.email.asFile(request);

PHP

$result = $api->email()->asFile($request);

AsMapi

Converts EmailDto to MapiMessageDto. Returns MapiMessageDto model. Requires:

emailDto

Email model to convert. Type: EmailDto.

var emailDto = new EmailDto
{
    Attachments = new List<Attachment>
    {
        new Attachment
        {
            Name = "some-file.txt",
            Base64Data = "U29tZSBmaWxlIGNvbnRlbnQ="
        }
    },
    Body = "Some body",
    BodyType = "Html",
    DeliveryNotificationOptions = new List<EmailDeliveryNotificationOptions>
    {
        "OnSuccess",
        "Delay"
    },
    From = new MailAddress
    {
        DisplayName = "From Address",
        Address = "from@aspose.com"
    },
    HtmlBody = "<b>Some body</b>",
    IsBodyHtml = true,
    IsDraft = true,
    Subject = "Re: Some subject",
    To = new List<MailAddress>
    {
        new MailAddress
        {
            DisplayName = "To Address",
            Address = "to@aspose.com"
        }
    }
};

Java

EmailDto emailDto = Models.emailDto()
    .attachments(Arrays.<Attachment>asList(
        Models.attachment()
            .name("some-file.txt")
            .base64Data("U29tZSBmaWxlIGNvbnRlbnQ=")
            .build()))
    .body("Some body")
    .bodyType("Html")
    .deliveryNotificationOptions(Arrays.<EmailDeliveryNotificationOptions>asList(
        "OnSuccess",
        "Delay"))
    .from(Models.mailAddress()
        .displayName("From Address")
        .address("from@aspose.com")
        .build())
    .htmlBody("<b>Some body</b>")
    .isBodyHtml(true)
    .isDraft(true)
    .subject("Re: Some subject")
    .to(Arrays.<MailAddress>asList(
        Models.mailAddress()
            .displayName("To Address")
            .address("to@aspose.com")
            .build()))
    .build();

Python

email_dto = models.EmailDto(
    attachments=[
        models.Attachment(
            name='some-file.txt',
            base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')],
    body='Some body',
    body_type='Html',
    delivery_notification_options=[
        'OnSuccess',
        'Delay'],
    _from=models.MailAddress(
        display_name='From Address',
        address='from@aspose.com'),
    html_body='<b>Some body</b>',
    is_body_html=True,
    is_draft=True,
    subject='Re: Some subject',
    to=[
        models.MailAddress(
            display_name='To Address',
            address='to@aspose.com')])

Ruby

email_dto = EmailDto.new(
  attachments: [
    Attachment.new(
      name: 'some-file.txt',
      base64_data: 'U29tZSBmaWxlIGNvbnRlbnQ=')],
  body: 'Some body',
  body_type: 'Html',
  delivery_notification_options: [
    'OnSuccess',
    'Delay'],
  from: MailAddress.new(
    display_name: 'From Address',
    address: 'from@aspose.com'),
  html_body: '<b>Some body</b>',
  is_body_html: true,
  is_draft: true,
  subject: 'Re: Some subject',
  to: [
    MailAddress.new(
      display_name: 'To Address',
      address: 'to@aspose.com')])

Typescript

let emailDto = Models.emailDto()
    .attachments([
        Models.attachment()
            .name('some-file.txt')
            .base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
            .build()])
    .body('Some body')
    .bodyType('Html')
    .deliveryNotificationOptions([
        'OnSuccess',
        'Delay'])
    .from(Models.mailAddress()
        .displayName('From Address')
        .address('from@aspose.com')
        .build())
    .htmlBody('<b>Some body</b>')
    .isBodyHtml(true)
    .isDraft(true)
    .subject('Re: Some subject')
    .to([
        Models.mailAddress()
            .displayName('To Address')
            .address('to@aspose.com')
            .build()])
    .build();

PHP

$email_dto = Models::emailDto()
    ->attachments(array(
        Models::attachment()
            ->name('some-file.txt')
            ->base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
            ->build()))
    ->body('Some body')
    ->bodyType('Html')
    ->deliveryNotificationOptions(array(
        'OnSuccess',
        'Delay'))
    ->from(Models::mailAddress()
        ->displayName('From Address')
        ->address('from@aspose.com')
        ->build())
    ->htmlBody('<b>Some body</b>')
    ->isBodyHtml(true)
    ->isDraft(true)
    ->subject('Re: Some subject')
    ->to(array(
        Models::mailAddress()
            ->displayName('To Address')
            ->address('to@aspose.com')
            ->build()))
    ->build();

var result = await api.Email.AsMapiAsync(emailDto);

Java

MapiMessageDto result = api.email().asMapi(emailDto);

Python

result = api.email.as_mapi(email_dto)

Ruby

result = api.email.as_mapi(email_dto)

Typescript

let result = await api.email.asMapi(emailDto);

PHP

$result = $api->email()->asMapi($email_dto);

Convert

Converts email document to specified format and returns as file.

Email documents could be stored in different formats including EML, and Outlook MSG formats. Also sometimes users need to convert email messages to HTML format, to view them in a web browser.

Returns a File. Requires:

request

Convert method request. Type: EmailConvertRequest.

var request = new EmailConvertRequest
{ 
    FromFormat = "Msg",
    ToFormat = "Mhtml",
    File = new MemoryStream(File.ReadAllBytes("/path/to/message.msg"))
};

Java

EmailConvertRequest request = Models.emailConvertRequest()
    .fromFormat("Msg")
    .toFormat("Mhtml")
    .file(IOUtils.toByteArray(new FileInputStream("/path/to/message.msg")))
    .build();

Python

request = models.EmailConvertRequest(
    from_format='Msg',
    to_format='Mhtml',
    file='/path/to/message.msg')

Ruby

request = EmailConvertRequest.new(
    from_format: 'Msg',
    to_format: 'Mhtml',
    file: File.new('/path/to/message.msg'))

Typescript

let request = Models.EmailConvertRequest()
    .fromFormat('Msg')
    .toFormat('Mhtml')
    .file(fs.readFileSync('/path/to/message.msg'))
    .build();

PHP

$request = Models::EmailConvertRequest()
    ->from_format('Msg')
    ->to_format('Mhtml')
    ->file(new SplFileObject('/path/to/message.msg'))
    ->build();

var result = await api.Email.ConvertAsync(request);

Java

byte[] result = api.email().convert(request);

Python

result = api.email.convert(request)

Ruby

result = api.email.convert(request)

Typescript

let result = await api.email.convert(request);

PHP

$result = $api->email()->convert($request);

FromFile

Converts email document to a model representation. Returns EmailDto model. Requires:

request

FromFile method request. Type: EmailFromFileRequest.

var request = new EmailFromFileRequest
{ 
    Format = "Eml",
    File = new MemoryStream(File.ReadAllBytes("/path/to/message.eml"))
};

Java

EmailFromFileRequest request = Models.emailFromFileRequest()
    .format("Eml")
    .file(IOUtils.toByteArray(new FileInputStream("/path/to/message.eml")))
    .build();

Python

request = models.EmailFromFileRequest(
    format='Eml',
    file='/path/to/message.eml')

Ruby

request = EmailFromFileRequest.new(
    format: 'Eml',
    file: File.new('/path/to/message.eml'))

Typescript

let request = Models.EmailFromFileRequest()
    .format('Eml')
    .file(fs.readFileSync('/path/to/message.eml'))
    .build();

PHP

$request = Models::EmailFromFileRequest()
    ->format('Eml')
    ->file(new SplFileObject('/path/to/message.eml'))
    ->build();

var result = await api.Email.FromFileAsync(request);

Java

EmailDto result = api.email().fromFile(request);

Python

result = api.email.from_file(request)

Ruby

result = api.email.from_file(request)

Typescript

let result = await api.email.fromFile(request);

PHP

$result = $api->email()->fromFile($request);

Get

Get email document from storage. Returns EmailDto model. Requires:

request

Get method request. Type: EmailGetRequest.

var request = new EmailGetRequest
{ 
    Format = "Eml",
    FileName = "email.eml",
    Folder = "folder/on/storage",
    Storage = "First Storage"
};

Java

EmailGetRequest request = Models.emailGetRequest()
    .format("Eml")
    .fileName("email.eml")
    .folder("folder/on/storage")
    .storage("First Storage")
    .build();

Python

request = models.EmailGetRequest(
    format='Eml',
    file_name='email.eml',
    folder='folder/on/storage',
    storage='First Storage')

Ruby

request = EmailGetRequest.new(
    format: 'Eml',
    file_name: 'email.eml',
    folder: 'folder/on/storage',
    storage: 'First Storage')

Typescript

let request = Models.EmailGetRequest()
    .format('Eml')
    .fileName('email.eml')
    .folder('folder/on/storage')
    .storage('First Storage')
    .build();

PHP

$request = Models::EmailGetRequest()
    ->format('Eml')
    ->file_name('email.eml')
    ->folder('folder/on/storage')
    ->storage('First Storage')
    ->build();

var result = await api.Email.GetAsync(request);

Java

EmailDto result = api.email().get(request);

Python

result = api.email.get(request)

Ruby

result = api.email.get(request)

Typescript

let result = await api.email.get(request);

PHP

$result = $api->email()->get($request);

GetAsFile

Converts email document from storage to specified format and returns as file. Returns a File. Requires:

request

GetAsFile method request. Type: EmailGetAsFileRequest.

var request = new EmailGetAsFileRequest
{ 
    FileName = "email.eml",
    Format = "Mhtml",
    Storage = "First Storage",
    Folder = "folder/on/storage"
};

Java

EmailGetAsFileRequest request = Models.emailGetAsFileRequest()
    .fileName("email.eml")
    .format("Mhtml")
    .storage("First Storage")
    .folder("folder/on/storage")
    .build();

Python

request = models.EmailGetAsFileRequest(
    file_name='email.eml',
    format='Mhtml',
    storage='First Storage',
    folder='folder/on/storage')

Ruby

request = EmailGetAsFileRequest.new(
    file_name: 'email.eml',
    format: 'Mhtml',
    storage: 'First Storage',
    folder: 'folder/on/storage')

Typescript

let request = Models.EmailGetAsFileRequest()
    .fileName('email.eml')
    .format('Mhtml')
    .storage('First Storage')
    .folder('folder/on/storage')
    .build();

PHP

$request = Models::EmailGetAsFileRequest()
    ->file_name('email.eml')
    ->format('Mhtml')
    ->storage('First Storage')
    ->folder('folder/on/storage')
    ->build();

var result = await api.Email.GetAsFileAsync(request);

Java

byte[] result = api.email().getAsFile(request);

Python

result = api.email.get_as_file(request)

Ruby

result = api.email.get_as_file(request)

Typescript

let result = await api.email.getAsFile(request);

PHP

$result = $api->email()->getAsFile($request);

GetList

Get email list from storage folder. Returns EmailStorageList model. Requires:

request

GetList method request. Type: EmailGetListRequest.

var request = new EmailGetListRequest
{ 
    Format = "Eml",
    Folder = "folder/on/storage",
    Storage = "First Storage",
    ItemsPerPage = 10,
    PageNumber = 0
};

Java

EmailGetListRequest request = Models.emailGetListRequest()
    .format("Eml")
    .folder("folder/on/storage")
    .storage("First Storage")
    .itemsPerPage(10)
    .pageNumber(0)
    .build();

Python

request = models.EmailGetListRequest(
    format='Eml',
    folder='folder/on/storage',
    storage='First Storage',
    items_per_page=10,
    page_number=0)

Ruby

request = EmailGetListRequest.new(
    format: 'Eml',
    folder: 'folder/on/storage',
    storage: 'First Storage',
    items_per_page: 10,
    page_number: 0)

Typescript

let request = Models.EmailGetListRequest()
    .format('Eml')
    .folder('folder/on/storage')
    .storage('First Storage')
    .itemsPerPage(10)
    .pageNumber(0)
    .build();

PHP

$request = Models::EmailGetListRequest()
    ->format('Eml')
    ->folder('folder/on/storage')
    ->storage('First Storage')
    ->items_per_page(10)
    ->page_number(0)
    ->build();

var result = await api.Email.GetListAsync(request);

Java

EmailStorageList result = api.email().getList(request);

Python

result = api.email.get_list(request)

Ruby

result = api.email.get_list(request)

Typescript

let result = await api.email.getList(request);

PHP

$result = $api->email()->getList($request);

Save

Save email document to storage. Requires:

request

Email document create/update request. Type: EmailSaveRequest.

var request = new EmailSaveRequest
{
    Format = "Msg",
    StorageFile = new StorageFileLocation
    {
        FileName = "email.eml",
        Storage = "First Storage",
        FolderPath = "file/location/folder/on/storage"
    },
    Value = new EmailDto
    {
        Attachments = new List<Attachment>
        {
            new Attachment
            {
                Name = "some-file.txt",
                Base64Data = "U29tZSBmaWxlIGNvbnRlbnQ="
            }
        },
        Body = "Some body",
        BodyType = "Html",
        DeliveryNotificationOptions = new List<EmailDeliveryNotificationOptions>
        {
            "OnSuccess",
            "Delay"
        },
        From = new MailAddress
        {
            DisplayName = "From Address",
            Address = "from@aspose.com"
        },
        HtmlBody = "<b>Some body</b>",
        IsBodyHtml = true,
        IsDraft = true,
        Subject = "Re: Some subject",
        To = new List<MailAddress>
        {
            new MailAddress
            {
                DisplayName = "To Address",
                Address = "to@aspose.com"
            }
        }
    }
};

Java

EmailSaveRequest request = Models.emailSaveRequest()
    .format("Msg")
    .storageFile(Models.storageFileLocation()
        .fileName("email.eml")
        .storage("First Storage")
        .folderPath("file/location/folder/on/storage")
        .build())
    .value(Models.emailDto()
        .attachments(Arrays.<Attachment>asList(
            Models.attachment()
                .name("some-file.txt")
                .base64Data("U29tZSBmaWxlIGNvbnRlbnQ=")
                .build()))
        .body("Some body")
        .bodyType("Html")
        .deliveryNotificationOptions(Arrays.<EmailDeliveryNotificationOptions>asList(
            "OnSuccess",
            "Delay"))
        .from(Models.mailAddress()
            .displayName("From Address")
            .address("from@aspose.com")
            .build())
        .htmlBody("<b>Some body</b>")
        .isBodyHtml(true)
        .isDraft(true)
        .subject("Re: Some subject")
        .to(Arrays.<MailAddress>asList(
            Models.mailAddress()
                .displayName("To Address")
                .address("to@aspose.com")
                .build()))
        .build())
    .build();

Python

request = models.EmailSaveRequest(
    format='Msg',
    storage_file=models.StorageFileLocation(
        file_name='email.eml',
        storage='First Storage',
        folder_path='file/location/folder/on/storage'),
    value=models.EmailDto(
        attachments=[
            models.Attachment(
                name='some-file.txt',
                base64_data='U29tZSBmaWxlIGNvbnRlbnQ=')],
        body='Some body',
        body_type='Html',
        delivery_notification_options=[
            'OnSuccess',
            'Delay'],
        _from=models.MailAddress(
            display_name='From Address',
            address='from@aspose.com'),
        html_body='<b>Some body</b>',
        is_body_html=True,
        is_draft=True,
        subject='Re: Some subject',
        to=[
            models.MailAddress(
                display_name='To Address',
                address='to@aspose.com')]))

Ruby

request = EmailSaveRequest.new(
  format: 'Msg',
  storage_file: StorageFileLocation.new(
    file_name: 'email.eml',
    storage: 'First Storage',
    folder_path: 'file/location/folder/on/storage'),
  value: EmailDto.new(
    attachments: [
      Attachment.new(
        name: 'some-file.txt',
        base64_data: 'U29tZSBmaWxlIGNvbnRlbnQ=')],
    body: 'Some body',
    body_type: 'Html',
    delivery_notification_options: [
      'OnSuccess',
      'Delay'],
    from: MailAddress.new(
      display_name: 'From Address',
      address: 'from@aspose.com'),
    html_body: '<b>Some body</b>',
    is_body_html: true,
    is_draft: true,
    subject: 'Re: Some subject',
    to: [
      MailAddress.new(
        display_name: 'To Address',
        address: 'to@aspose.com')]))

Typescript

let request = Models.emailSaveRequest()
    .format('Msg')
    .storageFile(Models.storageFileLocation()
        .fileName('email.eml')
        .storage('First Storage')
        .folderPath('file/location/folder/on/storage')
        .build())
    .value(Models.emailDto()
        .attachments([
            Models.attachment()
                .name('some-file.txt')
                .base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
                .build()])
        .body('Some body')
        .bodyType('Html')
        .deliveryNotificationOptions([
            'OnSuccess',
            'Delay'])
        .from(Models.mailAddress()
            .displayName('From Address')
            .address('from@aspose.com')
            .build())
        .htmlBody('<b>Some body</b>')
        .isBodyHtml(true)
        .isDraft(true)
        .subject('Re: Some subject')
        .to([
            Models.mailAddress()
                .displayName('To Address')
                .address('to@aspose.com')
                .build()])
        .build())
    .build();

PHP

$request = Models::emailSaveRequest()
    ->format('Msg')
    ->storageFile(Models::storageFileLocation()
        ->fileName('email.eml')
        ->storage('First Storage')
        ->folderPath('file/location/folder/on/storage')
        ->build())
    ->value(Models::emailDto()
        ->attachments(array(
            Models::attachment()
                ->name('some-file.txt')
                ->base64Data('U29tZSBmaWxlIGNvbnRlbnQ=')
                ->build()))
        ->body('Some body')
        ->bodyType('Html')
        ->deliveryNotificationOptions(array(
            'OnSuccess',
            'Delay'))
        ->from(Models::mailAddress()
            ->displayName('From Address')
            ->address('from@aspose.com')
            ->build())
        ->htmlBody('<b>Some body</b>')
        ->isBodyHtml(true)
        ->isDraft(true)
        ->subject('Re: Some subject')
        ->to(array(
            Models::mailAddress()
                ->displayName('To Address')
                ->address('to@aspose.com')
                ->build()))
        ->build())
    ->build();

await api.Email.SaveAsync(request);

Java

api.email().save(request);

Python

api.email.save(request)

Ruby

api.email.save(request)

Typescript

await api.email.save(request);

PHP

$api->email()->save($request);

More APIs

Client