Kazuho Oku > WWW-CybozuOffice6-0.04 > WWW::CybozuOffice6

Download:
WWW-CybozuOffice6-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.04   Source  

NAME ^

WWW::CybozuOffice6 - Perl extension for accessing Cybozu Office 6

SYNOPSIS ^

 use WWW::CybozuOffice6;

 # create a new object  
 $office6 =
     WWW::CybozuOffice6->new(url => 'http://server/scripts/cbag/ag.exe',
                             user => 'username',
                             pass => 'password');

 # check if username/password is correct
 $office6->test_credentials;
 
 # get list of new items
 $new_items = $office6->externalAPINotify;

DESCRIPTION ^

WWW::CybozuOffice6 is a perl extension for accessing Cybozu Office 6.

FUNCTIONS ^

new(%attr)

Returns a new instance of WWW::CybozuOffice6. Following attributes are available.

url

The URL of the Cybozu Office 6.

user

Username for the Cybozu Office.

pass

Password for the Cybozu Office.

ua

(optional) An LWP::UserAgent object used for access.

ocode

Output encoding, default is utf8.

url([$new_url])

Gets/sets the Cybozu Office 6 URL.

user([$new_user])

Gets/sets the Cybozu Office 6 username.

password([$new_password])

Gets/sets the Cybozu Office 6 password.

ua([$new_ua])

Gets/sets the LWP::UserAgent object used to access the Cybozu Office 6.

response()

Returns the last response from Cybozu Office 6.

ocode([$new_ocode])

Gets/sets the output encoding.

test_credentials()

Checks if username/password is correct.

externalAPINotify()

Obtains a list of new items from the Cybozu Office 6. If successful, an array of new items is returned, of which the keys for each item are:

app

Name of the application (ex. message, forum)

app_jp

Name of the application in Japanese printable form

timestamp

Creation(?) time of the item, in unix time.

title

Title of the item.

description

Description of the item. May contain '\x0a's.

from

Creator of the item, in Japanese printable form.

link

URL of the item, only the query portion is included.

EXPORT ^

None by default.

AUTHOR ^

Kazuho Oku <kazuho ___at___ labs.cybozu.co.jp>

Copyright (C) 2005 Cybozu Labs, Inc.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.

This package is NOT a product of Cybozu, Inc. DO NOT CONTACT CYBOZU, INC. for the use of the software.

For support, please visit http://labs.cybozu.co.jp/blog/kazuho/

syntax highlighting: