Editing the Address Book Using a CSV File
This section describes the description of the CSV file that is saved when the Address Book is exported in the CSV format.
The CSV file content consists of the header and the body. You can edit the attributes in the body directly to add or change destinations in the Address Book.
The CSV file content consists of the header and the body. You can edit the attributes in the body directly to add or change destinations in the Address Book.
Header
In the header of the CSV file, the following information is described:
Information | Required | Supplementary explanation |
# Canon AddressBook CSV version: 0x0002 |  | Fixed value. |
# Charset: UTF-8 | | Fixed value. |
# dn: fixed | *1 | Indicates that "dn" is to be handled as a one-touch number. Describe when the import destination is the One-Touch Address List. This is described when the data has been exported from the One-Touch Address List. |
# SubAddressBookName: Address list name | | Add a single-byte space after the colon (:) and enter the name of the address list following the space. When you are not going to set the address list name, leave it blank (enter no value) after the colon. |
# DB Version: 0x010a | | Fixed value. |
# Crypto Version: 2 | When creating a new CSV file of the Address Book, do not describe this. | |
# Crypto Attribute: pwd | When creating a new CSV file of the Address Book, do not describe this. |
*1For the One-Touch Address List only.
NOTE
When the Header Information Related to "Crypto" Is Described
To edit the pwd attribute of the machine, deleted the two "Crypto" header items. If the "Crypto"-related header items are described, the password will not be decoded correctly when import is performed.
The "Crypto"-related header items are described when the password set for the address is encrypted.
The "Crypto"-related header items are described when the password set for the address is encrypted.
Attributes in the Body
In the body of the CSV file, the following attributes indicating the address information are described:
Attribute name | Required | Explanation |
objectclass | | Destination type. Specify one of the following types. According to the type you specify, the required attributes that follow will vary. E-mail: email Fax: g3fax I-Fax: ifax IP Fax: ipfax File store locations (shared folder, file server, and Advanced Box): remotefilesystem Group: groupfid |
cn | Destination name. UTF-8 encoded characters can be used. If this is omitted, the destination name will be blank. | |
cnread | Phonetic alphabet for the destination name. When the display language is set to "Japanese," it will be displayed as "phonogram." | |
cnshort | One-touch button name. UTF-8 encoded characters can be used. If this is omitted, the one-touch button name will be blank. | |
subdbid | Address list number of the import destination. Description is not needed. Specify on Remote UI when performing import. | |
mailaddess | *1 | E-mail address. This is required when the destination type is an e-mail or I-Fax. |
dialdata | *1 | Fax number. This is required when the destination type is a fax. Entry is not needed when the destination type is an IP Fax and the URI is used. |
uri | *1 | URI used for an IP Fax. This is required when the destination type is an IP Fax and the URI is used. You need to set also the uriflag attribute (URI usage flag). |
url | *1 | Host name or IP address. This is required when the destination type is a file store location. You can use alphabet and symbols. |
path | Path for a file store location (folder). You can use alphabet and symbols. | |
protocol | *1 | Send protocol. This is required when the destination type is a file store location. Enter one of the following: For SMB: smb For FTP: ftp For WebDAV: addonprotocol0225 |
username | *1 | User name for logging in to the destination. This is required when the destination type is a file store location and the destination requires authentication. |
pwd | *1 | Password for logging in to the destination. This is required when the destination type is a file store location and the destination requires authentication. |
member | *1 | Destination or Mail Box registered in a group. This is required when the destination type is a group. |
indxid | | Serial number assigned to the destination. According to the import destination, the value to be input varies. For One-Touch Address List: This is required. Enter the one-touch button number (001 - 200) for which to register the destination. For address lists other than One-Touch Address List: Enter any number between 201 and 1800. |
enablepartial | Data division setting when sending by e-mail. When dividing the data: on When not dividing the data: off | |
sub | Subaddress used when the destination is a fax. | |
faxprotocol | Fax protocol. Enter one of the following: g3 ecm | |
ecm | ECM transmission settings for the fax function. When ECM transmission is enabled: on When ECM transmission is disabled: off | |
txstartspeed | Fax sending speed. Enter one of the following: 2400, 4800, 7200, 9600, 14400, 33600. | |
commode | Fax communication mode. Enter one of the following: For domestic PSTN: domestic For international PSTN 1: international1 For international PSTN 2: international2 For international PSTN 3: international3 | |
lineselect | Fax line selection. Enter one of the following: For lines 1 to 4: line1, line2, line3, or line4 When line is selected automatically: auto If this is omitted, it will be set to "auto." | |
uricommode | *1 | IP Fax communication mode. This is required when the destination type is a fax in an environment where IP Fax is used. Enter one of the following: For G3: ip_g3 For intranet: ip_lsv For VoIP gateway: ip_gw |
uriflag | *1 | URI usage flag for an IP Fax. This is required when the destination type is an IP Fax and the URI is used. When using URI: TRUE When not using URI: FALSE |
pwdinputflag | Setting whether to require password entry each time. When requiring entry: on When not requiring entry: off | |
ifaxmodeI | I-Fax mode (simple or full). Enter "simple" or "full." | |
transsvcstr1 | Character string 1 for an I-Fax relay service. Enter a string within 40 single-byte characters. | |
transsvcstr2 | Character string 2 for an I-Fax relay service. Enter a string within 16 single-byte characters. | |
ifaxdirectmode | I-Fax Direct Send. When performing Direct Send: on When not performing Direct Send: off | |
documenttype | I-Fax document type. Enter one of the following: When sending faxes in color: cl When sending faxes in black and white: bw | |
bwpapersize | Paper size for I-Faxes. | |
bwcompressiontype | Compression format for I-Faxes. | |
bwpixeltype | Color space for I-Faxes. | |
bwbitsperpixel | Number of bits for I-Faxes. | |
bwresolution | Resolution for I-Faxes. | |
clpapersize | Paper size for color I-Faxes. | |
clcompressiontype | Compression format for color I-Faxes. Fixed to "jpeg." | |
clpixeltype | Color space for color I-Faxes. Fixed to "rgb." | |
clbitsperpixel | Number of bits for color I-Faxes. Fixed to "8." | |
clresolution | Resolution for color I-Faxes. | |
accesscode | Access code. Enter a value using single-byte numerals within seven digit. | |
uuid | UUID to uniquely identify the destination. When creating a new CSV file, this is not required to be entered. | |
cnreadlang | Phonetic alphabet code. When the display language is set to "Japanese," it will be displayed as "phonogram." Enter the language code. For Japanese (SJIS), enter "ja." | |
enablesfp | Not required to be entered as this is not used. | |
memberobjectuuid | Attribute for a personal address list or a user group address list. | |
loginusername | Attribute for a personal address list or a user group address list. | |
logindomainname | Attribute for a personal address list or a user group address list. | |
usergroupname | Attribute for a personal address list or a user group address list. | |
personalid | Attribute for a personal address list or a user group address list. |
*1 Depends on the destination type.