Duncan Garland > Mail-Outlook-0.19a > Mail::Outlook

Download:
Mail-Outlook-0.19a.zip

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
Stalled  1
View/Report Bugs
Module Version: 0.19   Source   Latest Release: Mail-Outlook-0.23

NAME ^

Mail::Outlook - mail module to interface with Microsoft (R) Outlook (R).

SYNOPSIS ^

  # create the object
  use Mail::Outlook;
  my $outlook = new Mail::Outlook();

  # start with a folder
  my $outlook = new Mail::Outlook('Inbox');

  # use the Win32::OLE::Const definitions
  use Mail::Outlook;
  use Win32::OLE::Const 'Microsoft Outlook';
  my $outlook = new Mail::Outlook(olInbox);

  # get/set the current folder
  my $folder = $outlook->folder();
  my $folder = $outlook->folder('Inbox');

  # get the first/last/next/previous message
  my $message = $folder->first();
     $message = $folder->next();
     $message = $folder->last();
     $message = $folder->previous();

  # read the attributes of the current message
  my $text = $message->From();
     $text = $message->To();
     $text = $message->Cc();
     $text = $message->Bcc();
     $text = $message->Subject();
     $text = $message->Body();
  my @list = $message->Attach();

  # use Outlook to display the current message
  $message->display;

  # create a message for sending
  my $message = $outlook->create();
  $message->To('you@example.com');
  $message->Cc('Them <them@example.com>');
  $message->Bcc('Us <us@example.com>; anybody@example.com');
  $message->Subject('Blah Blah Blah');
  $message->Body('Yadda Yadda Yadda');
  $message->Attach(@lots_of_files);
  $message->Attach(@more_files);    # attachments are appended
  $message->Attach($one_file);      # so multiple calls are allowed
  $message->send;

  # Or use a hash
  my %hash = (
     To      => 'you@example.com',
     Cc      => 'Them <them@example.com>',
     Bcc     => 'Us <us@example.com>, anybody@example.com',
     Subject => 'Blah Blah Blah',
     Body    => 'Yadda Yadda Yadda',
  );

  my $message = $outlook->create(%hash);
  $message->display(%hash);
  $message->send(%hash);

DESCRIPTION ^

This module was written to overcome the problem of sending mail messages, where Microsoft (R) Outlook (R) is the only mail application available. However, since it's inception the module has expanded to handle a range of Outlook mail functionality.

Note that when sending messages, the module uses the named owner of the Outbox MAPI Folder in order to access the correct objects. Thus the From field of a new message is predetermined, and therefore a read only property.

If using the 'Win32::OLE::Const' constants, only the following are supported:

  olFolderInbox
  olFolderOutbox
  olFolderSentMail
  olFolderDrafts
  olFolderDeletedItems

ABSTRACT ^

A mail module to interface with mail message accessible via Microsoft (R) Outlook (R).

METHODS ^

new()

Create a new Outlook mail object. Returns the object on success or undef on failure. To see the last error use 'Win32::OLE->LastError();'.

DESTROY

Free unused Win32::OLE libraries

all_folders()

Get the list of all open mail folders in Outlook

folder()

Gets or sets the current folder object.

create(%hash)

Creates a new message. Option hash table can be used. Returns the new message object or undef on failure.

FURTHER READING ^

If you intend to supply a patch for a bug or new feature, please visit the following URL (and associated pages) to ensure you are using the correct objects and methods.

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/off2000/html/olobjApplication.asp

This article contains some interesting background into creating mail messages via Outlook, although it is VB-centric.

http://www.exchangeadmin.com/Articles/Index.cfm?ArticleID=4657

FUTURE ENHANCEMENTS ^

A couple of items that I'd like to get working.

* X-Header support * Send without the popups (Outlook Redemption looks possible)

NOTES ^

This module is intended to be used on Win32 platforms only, with Microsoft (R) Outlook (R) installed.

  Microsoft and Outlook are registered trademarks and the copyright 1995-2003
  of Microsoft Corporation.

SEE ALSO ^

  Win32::OLE
  Win32::OLE::Const

BUGS, PATCHES & FIXES ^

There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties that are not explained within the POD documentation, please submit a bug to the RT system (see link below). However, it would help greatly if you are able to pinpoint problems or even supply a patch.

Fixes are dependent upon their severity and my availability. Should a fix not be forthcoming, please feel free to (politely) remind me by sending an email to barbie@cpan.org .

RT: http://rt.cpan.org/Public/Dist/Display.html?Name=Mail-Outlook

AUTHOR ^

  Barbie, <barbie@cpan.org>
  for Miss Barbell Productions, <http://www.missbarbell.co.uk>

COPYRIGHT AND LICENSE ^

  Copyright E<copy> 2003-2013 Barbie for Miss Barbell Productions.

  This distribution is free software; you can redistribute it and/or
  modify it under the Artistic License v2.
syntax highlighting: