Address Book Items
This section describes each column of the Address Book. Refer to this section when editing CSV files.
Header
|
Header Name
|
Required
|
Notes
|
|
# Canon AddressBook CSV version: 0x0002
|
Yes
|
Fixed value
|
|
# CharSet: UTF-8
|
Yes
|
Fixed value
|
|
# dn: fixed
|
Yes
(Required for One-touch button Address Book) |
Indicates that the destination name is handled as a one-touch button. Entry is only required when the import destination is a one-touch button Address Book.
Added when exporting from a one-touch button Address Book, so there is no need to add this item again when importing. |
|
# SubAddressBookName: Address Book name
|
Yes
|
Enter the Address Book name after the colon (:), with a space in between. If the Address Book is unnamed, leave the space after the colon (:) blank.
|
|
# DB Version: 0x010a
|
Yes
|
Fixed value
|
|
# Crypto Version: 2
|
No
|
Leave this section blank if you are creating a new Address Book CSV file.
|
|
# Crypto Attribute: pwd
|
No
|
Leave this section blank if you are creating a new Address Book CSV file.
|
 |
|
The presence a header relating to "Crypt" in a header indicates that the password attribute is encrypted. However, when entering this information into a newly-created CSV file, or when editing the pwd attribute of an exported CSV file, encryption cannot be performed in a manner that allows the machine to correctly decode. In such cases, delete the corresponding portion from the header.
|
Body
|
Attribute Name
|
Description
|
Required
|
Notes
|
|
objectclass
|
Object class (destination type)
|
Yes
|
Indicates the type of destination. The required attribute varies according to this value. Enter one of the following.
For e-mail: email
For G3 fax: g3fax
For IP fax: ipfax
For fax: ifax
For file server (SMB, FTP, WebDAV): remotefilesystem
For group: groupfids
|
|
cn
|
Destination name
|
No
|
Enter in UTF-8 character code. Otherwise, the destination name will be left blank.
|
|
cnread
|
Phonetic alphabet
|
No
|
Displayed as "phonetic" if the display language is set to "Japanese".
|
|
cnshort
|
One-touch button name
|
No
|
Enter in UTF-8 character code. Otherwise, the one-touch button name will be left blank.
|
|
subdbid
|
Address Book number
|
No
|
Specify which Address Book to import to in the Remote UI. Not required when writing to a CSV file.
|
|
mailaddress
|
E-mail address
|
Yes
(Required for certain destination types) |
This attribute is required for e-mail and I-fax destinations.
|
|
dialdata
|
Fax number
|
Yes
(Required for certain destination types) |
This attribute is required for fax destinations. However, it is not required if the destination is an IP fax using a URI.
|
|
uri
|
The URI used with an IP fax
|
Yes
(Required for certain destination types) |
Only usable for IP fax destinations. This attribute is required if you do not specify a fax number for an IP fax.
For an IP fax destination using a URI, you must also specify the "URI flag" (see below). |
|
url
|
File server destination host name
|
Yes
(Required for certain destination types) |
This attribute is required for file server destinations. You can only use letters and symbols.
|
|
path
|
File path for file server destination
|
No
|
You can only use letters and symbols.
|
|
protocol
|
Protocol
|
Yes
(Required for certain destination types) |
This attribute is required for file server destinations. Enter one of the following.
For SMB: smb
For FTP: ftp
For WebDAV: addonprotocol0225
|
|
username
|
User name used when logging in to a file server destination
|
Yes
(Required for certain destination types) |
This attribute is required for FTP file server destinations. The user ID is required to log in to a file sending destination, and therefore is also required for file sending destinations using authentication, such as SMB and WebDAV.
|
|
pwd
|
Password used when logging in to a file server destination
|
No
|
This attribute is required for file sending destinations using authentication.
|
|
member
|
A member of a group destination
|
Yes
(Required for certain destination types) |
This attribute is required for group destinations.
|
|
indxid
|
A serial number allocated to a destination
|
Yes
|
This attribute is required if the import destination is a one-touch button Address Book. This number becomes the one-touch button number. In other cases, enter a number from 201 to 1,800.
|
|
enablepartial
|
Setting for dividing data when sending an e-mail
|
No
|
Enter either "on" or "off".
|
|
sub
|
Subaddress of a file server destination
|
No
|
|
|
faxprotocol
|
Fax protocol
|
No
|
Enter one of the following.
g3
ecm
|
|
ecm
|
Indicates the use of ECM.
|
No
|
Enter either "on" or "off".
|
|
txstartspeed
|
Starting transmission speed for faxing
|
No
|
Enter one of the following.
2400
4800
7200
9600
14400
33600
|
|
commode
|
Fax communication mode
Setting regarding international sending
|
No
|
Enter one of the following.
For PSTN domestic line: domestic
For PSTN international line 1: international1
For PSTN international line 2: international2
For PSTN international line 3: international3
|
|
lineselect
|
Selected fax line
|
No
|
Enter one of the following. Otherwise, "auto" is used.
For lines 1 to 4: line1, line2, line3, or line4
For automatic line specification: auto
|
|
uricommode
|
IP fax communication mode
|
Yes
(Required for certain destination types) |
This is the chosen communication mode for IP faxes. This attribute is required if you use IP faxing, and are sending to a fax destination.
Enter one of the following. For G3: ip_g3
For intranet: ip_lsv
For a VoIP gateway: ip_gw
|
|
uriflag
|
The flag for a URI used with an IP fax
|
Yes
(Required for certain destination types) |
This attribute is required if the destination is an IP fax, and you use a URI instead of a fax number. Enter either "TRUE" or "FALSE". If you use a URI, enter "TRUE".
|
|
pwdinputflag
|
Setting for requesting password input per transmission
|
No
|
Enter either "on" or "off".
|
|
ifaxmode
|
I-Fax mode (simple/full)
|
No
|
Enter either "simple" or "full".
|
|
transsvcstr1
|
I-fax relay service text string 1
|
No
|
Enter total of up to 40 alphanumeric characters and symbols.
|
|
transsvcstr2
|
I-fax relay service text string 2
|
No
|
Enter total of up to 16 alphanumeric characters and symbols.
|
|
ifaxdirectmode
|
I-fax direct sending
|
No
|
Enter either "on" or "off".
|
|
documenttype
|
I-fax document type
|
No
|
Enter one of the following.
To send in color: cl
To send in black and white: bw
|
|
bwpapersize
|
Paper size allowable when sending an I-fax
|
No
|
|
|
bwcompressiontype
|
Compression format used when sending an I-fax
|
No
|
|
|
bwpixeltype
|
Color space allowable when sending an I-fax
|
No
|
|
|
bwbitsperpixel
|
Bit count allowable when sending an I-fax
|
No
|
|
|
bwresolution
|
Resolution allowable when sending an I-fax
|
No
|
|
|
clpapersize
|
Paper size allowable when sending a color I-fax
|
No
|
|
|
clcompressiontype
|
Compression format used when sending a color I-fax
|
No
|
Fixed as "jpeg".
|
|
clpixeltype
|
Color space allowable when sending a color I-fax
|
No
|
Fixed as "rgb".
|
|
clbitsperpixel
|
Bit count allowable when sending a color I-fax
|
No
|
Fixed as "8".
|
|
clresolution
|
Resolution allowable when sending a color I-fax
|
No
|
|
|
accesscode
|
Access code
|
No
|
Enter up to seven numbers.
|
|
uuid
|
A UUID for identifying a destination
|
No
|
This item is not necessary when creating a new CSV file.
|
|
cnreadlang
|
Phonetic alphabet character code
|
No
|
Displayed as "phonetic" if the display language is set to "Japanese". Enter the language code to use. For Japanese (SJIS), enter "ja".
|
|
enablesfp
|
Unused
|
No
|
This item is unused, and therefore does not need to be entered.
|
|
memberobjectuuid
|
Used for Personal Address List/User Group Address List
|
No
|
|
|
loginusername
|
Used for Personal Address List/User Group Address List
|
No
|
|
|
logindomainname
|
Used for Personal Address List/User Group Address List
|
No
|
|
|
usergroupname
|
Used for Personal Address
List/User Group Address List |
No
|
|
|
personalid
|
Used for Personal Address List/User Group Address List
|
No
|